# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.Bedrock do
@moduledoc """
Describes the API operations for creating, managing, fine-turning, and
evaluating Amazon Bedrock models.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
model_customization_job_summary() :: %{
"baseModelArn" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"customModelArn" => String.t() | atom(),
"customModelName" => String.t() | atom(),
"customizationType" => list(any()),
"endTime" => non_neg_integer(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"status" => list(any()),
"statusDetails" => status_details()
}
"""
@type model_customization_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_custom_models_request() :: %{
optional("baseModelArnEquals") => String.t() | atom(),
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("foundationModelArnEquals") => String.t() | atom(),
optional("isOwned") => [boolean()],
optional("maxResults") => integer(),
optional("modelStatus") => list(any()),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any())
}
"""
@type list_custom_models_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policies_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("policyArn") => String.t() | atom()
}
"""
@type list_automated_reasoning_policies_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_automated_reasoning_policy_version_response() :: %{
"policyDefinition" => automated_reasoning_policy_definition()
}
"""
@type export_automated_reasoning_policy_version_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
marketplace_model_endpoint_summary() :: %{
"createdAt" => non_neg_integer(),
"endpointArn" => String.t() | atom(),
"modelSourceIdentifier" => String.t() | atom(),
"status" => list(any()),
"statusMessage" => [String.t() | atom()],
"updatedAt" => non_neg_integer()
}
"""
@type marketplace_model_endpoint_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_automated_reasoning_policy_config() :: %{
"confidenceThreshold" => float(),
"policies" => list(String.t() | atom())
}
"""
@type guardrail_automated_reasoning_policy_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_next_scenario_request() :: %{}
"""
@type get_automated_reasoning_policy_next_scenario_request() :: %{}
@typedoc """
## Example:
delete_provisioned_model_throughput_response() :: %{}
"""
@type delete_provisioned_model_throughput_response() :: %{}
@typedoc """
## Example:
create_model_import_job_response() :: %{
"jobArn" => String.t() | atom()
}
"""
@type create_model_import_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_test_result_request() :: %{}
"""
@type get_automated_reasoning_policy_test_result_request() :: %{}
@typedoc """
## Example:
get_evaluation_job_response() :: %{
"applicationType" => list(any()),
"creationTime" => non_neg_integer(),
"customerEncryptionKeyId" => String.t() | atom(),
"evaluationConfig" => list(),
"failureMessages" => list(String.t() | atom()),
"inferenceConfig" => list(),
"jobArn" => String.t() | atom(),
"jobDescription" => String.t() | atom(),
"jobName" => String.t() | atom(),
"jobType" => list(any()),
"lastModifiedTime" => non_neg_integer(),
"outputDataConfig" => evaluation_output_data_config(),
"roleArn" => String.t() | atom(),
"status" => list(any())
}
"""
@type get_evaluation_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
foundation_model_summary() :: %{
"customizationsSupported" => list(list(any())()),
"inferenceTypesSupported" => list(list(any())()),
"inputModalities" => list(list(any())()),
"modelArn" => String.t() | atom(),
"modelId" => String.t() | atom(),
"modelLifecycle" => foundation_model_lifecycle(),
"modelName" => String.t() | atom(),
"outputModalities" => list(list(any())()),
"providerName" => String.t() | atom(),
"responseStreamingSupported" => [boolean()]
}
"""
@type foundation_model_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_marketplace_model_endpoints_response() :: %{
"marketplaceModelEndpoints" => list(marketplace_model_endpoint_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_marketplace_model_endpoints_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
metadata_attribute_schema() :: %{
"description" => [String.t() | atom()],
"key" => [String.t() | atom()],
"type" => list(any())
}
"""
@type metadata_attribute_schema() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_content_filters_tier_config() :: %{
"tierName" => list(any())
}
"""
@type guardrail_content_filters_tier_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("resourceARN") => String.t() | atom(),
required("tags") => list(tag())
}
"""
@type tag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_guardrail_request() :: %{
optional("guardrailVersion") => String.t() | atom()
}
"""
@type delete_guardrail_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_model_invocation_job_request() :: %{}
"""
@type stop_model_invocation_job_request() :: %{}
@typedoc """
## Example:
automated_reasoning_policy_delete_type_annotation() :: %{
"name" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_type_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_custom_model_response() :: %{}
"""
@type delete_custom_model_response() :: %{}
@typedoc """
## Example:
evaluation_inference_config_summary() :: %{
"modelConfigSummary" => evaluation_model_config_summary(),
"ragConfigSummary" => evaluation_rag_config_summary()
}
"""
@type evaluation_inference_config_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policies_response() :: %{
"automatedReasoningPolicySummaries" => list(automated_reasoning_policy_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_automated_reasoning_policies_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_model_invocation_job_response() :: %{
"jobArn" => String.t() | atom()
}
"""
@type create_model_invocation_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_inference_profiles_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("typeEquals") => list(any())
}
"""
@type list_inference_profiles_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_build_workflow_result_assets_response() :: %{
"buildWorkflowAssets" => list(),
"buildWorkflowId" => String.t() | atom(),
"policyArn" => String.t() | atom()
}
"""
@type get_automated_reasoning_policy_build_workflow_result_assets_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
batch_delete_evaluation_job_error() :: %{
"code" => [String.t() | atom()],
"jobIdentifier" => String.t() | atom(),
"message" => [String.t() | atom()]
}
"""
@type batch_delete_evaluation_job_error() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
offer() :: %{
"offerId" => String.t() | atom(),
"offerToken" => String.t() | atom(),
"termDetails" => term_details()
}
"""
@type offer() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_evaluation_job_request() :: %{}
"""
@type get_evaluation_job_request() :: %{}
@typedoc """
## Example:
get_foundation_model_availability_request() :: %{}
"""
@type get_foundation_model_availability_request() :: %{}
@typedoc """
## Example:
stop_evaluation_job_response() :: %{}
"""
@type stop_evaluation_job_response() :: %{}
@typedoc """
## Example:
get_provisioned_model_throughput_request() :: %{}
"""
@type get_provisioned_model_throughput_request() :: %{}
@typedoc """
## Example:
automated_reasoning_policy_definition_type_value_pair() :: %{
"typeName" => String.t() | atom(),
"valueName" => String.t() | atom()
}
"""
@type automated_reasoning_policy_definition_type_value_pair() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_policy_planning() :: %{}
"""
@type automated_reasoning_policy_planning() :: %{}
@typedoc """
## Example:
create_model_customization_job_response() :: %{
"jobArn" => String.t() | atom()
}
"""
@type create_model_customization_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
sage_maker_endpoint() :: %{
"executionRole" => String.t() | atom(),
"initialInstanceCount" => integer(),
"instanceType" => String.t() | atom(),
"kmsEncryptionKey" => String.t() | atom(),
"vpc" => vpc_config()
}
"""
@type sage_maker_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_guardrail_response() :: %{
"automatedReasoningPolicy" => guardrail_automated_reasoning_policy(),
"blockedInputMessaging" => String.t() | atom(),
"blockedOutputsMessaging" => String.t() | atom(),
"contentPolicy" => guardrail_content_policy(),
"contextualGroundingPolicy" => guardrail_contextual_grounding_policy(),
"createdAt" => non_neg_integer(),
"crossRegionDetails" => guardrail_cross_region_details(),
"description" => String.t() | atom(),
"failureRecommendations" => list(String.t() | atom()),
"guardrailArn" => String.t() | atom(),
"guardrailId" => String.t() | atom(),
"kmsKeyArn" => String.t() | atom(),
"name" => String.t() | atom(),
"sensitiveInformationPolicy" => guardrail_sensitive_information_policy(),
"status" => list(any()),
"statusReasons" => list(String.t() | atom()),
"topicPolicy" => guardrail_topic_policy(),
"updatedAt" => non_neg_integer(),
"version" => String.t() | atom(),
"wordPolicy" => guardrail_word_policy()
}
"""
@type get_guardrail_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
foundation_model_details() :: %{
"customizationsSupported" => list(list(any())()),
"inferenceTypesSupported" => list(list(any())()),
"inputModalities" => list(list(any())()),
"modelArn" => String.t() | atom(),
"modelId" => String.t() | atom(),
"modelLifecycle" => foundation_model_lifecycle(),
"modelName" => String.t() | atom(),
"outputModalities" => list(list(any())()),
"providerName" => String.t() | atom(),
"responseStreamingSupported" => [boolean()]
}
"""
@type foundation_model_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_topic_policy_config() :: %{
"tierConfig" => guardrail_topics_tier_config(),
"topicsConfig" => list(guardrail_topic_config())
}
"""
@type guardrail_topic_policy_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_invocation_jobs_request() :: %{
optional("maxResults") => integer(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("statusEquals") => list(any()),
optional("submitTimeAfter") => non_neg_integer(),
optional("submitTimeBefore") => non_neg_integer()
}
"""
@type list_model_invocation_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_variable_annotation() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"newName" => String.t() | atom()
}
"""
@type automated_reasoning_policy_update_variable_annotation() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
create_guardrail_request() :: %{
optional("automatedReasoningPolicyConfig") => guardrail_automated_reasoning_policy_config(),
optional("clientRequestToken") => String.t() | atom(),
optional("contentPolicyConfig") => guardrail_content_policy_config(),
optional("contextualGroundingPolicyConfig") => guardrail_contextual_grounding_policy_config(),
optional("crossRegionConfig") => guardrail_cross_region_config(),
optional("description") => String.t() | atom(),
optional("kmsKeyId") => String.t() | atom(),
optional("sensitiveInformationPolicyConfig") => guardrail_sensitive_information_policy_config(),
optional("tags") => list(tag()),
optional("topicPolicyConfig") => guardrail_topic_policy_config(),
optional("wordPolicyConfig") => guardrail_word_policy_config(),
required("blockedInputMessaging") => String.t() | atom(),
required("blockedOutputsMessaging") => String.t() | atom(),
required("name") => String.t() | atom()
}
"""
@type create_guardrail_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_type_annotation() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"values" => list(automated_reasoning_policy_definition_type_value())
}
"""
@type automated_reasoning_policy_add_type_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
text_inference_config() :: %{
"maxTokens" => integer(),
"stopSequences" => list([String.t() | atom()]()),
"temperature" => float(),
"topP" => float()
}
"""
@type text_inference_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_marketplace_model_endpoints_request() :: %{
optional("maxResults") => integer(),
optional("modelSourceEquals") => String.t() | atom(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_marketplace_model_endpoints_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_summary() :: %{
"arn" => String.t() | atom(),
"createdAt" => non_neg_integer(),
"crossRegionDetails" => guardrail_cross_region_details(),
"description" => String.t() | atom(),
"id" => String.t() | atom(),
"name" => String.t() | atom(),
"status" => list(any()),
"updatedAt" => non_neg_integer(),
"version" => String.t() | atom()
}
"""
@type guardrail_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
guardrail_word_policy() :: %{
"managedWordLists" => list(guardrail_managed_words()),
"words" => list(guardrail_word())
}
"""
@type guardrail_word_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_evaluation_jobs_request() :: %{
optional("applicationTypeEquals") => list(any()),
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("statusEquals") => list(any())
}
"""
@type list_evaluation_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_test_case_response() :: %{
"policyArn" => String.t() | atom(),
"testCase" => automated_reasoning_policy_test_case()
}
"""
@type get_automated_reasoning_policy_test_case_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_inference_profile_response() :: %{
"inferenceProfileArn" => String.t() | atom(),
"status" => list(any())
}
"""
@type create_inference_profile_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
external_source() :: %{
"byteContent" => byte_content_doc(),
"s3Location" => s3_object_doc(),
"sourceType" => list(any())
}
"""
@type external_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_evaluation_config() :: %{
"customMetricConfig" => automated_evaluation_custom_metric_config(),
"datasetMetricConfigs" => list(evaluation_dataset_metric_config()),
"evaluatorModelConfig" => list()
}
"""
@type automated_evaluation_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_in_use_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_in_use_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_topic_config() :: %{
"definition" => String.t() | atom(),
"examples" => list(String.t() | atom()),
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"name" => String.t() | atom(),
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"type" => list(any())
}
"""
@type guardrail_topic_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_inference_profile_response() :: %{
"createdAt" => non_neg_integer(),
"description" => String.t() | atom(),
"inferenceProfileArn" => String.t() | atom(),
"inferenceProfileId" => String.t() | atom(),
"inferenceProfileName" => String.t() | atom(),
"models" => list(inference_profile_model()),
"status" => list(any()),
"type" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type get_inference_profile_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_topics_tier() :: %{
"tierName" => list(any())
}
"""
@type guardrail_topics_tier() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_type_annotation() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"newName" => String.t() | atom(),
"values" => list(list())
}
"""
@type automated_reasoning_policy_update_type_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
human_workflow_config() :: %{
"flowDefinitionArn" => String.t() | atom(),
"instructions" => String.t() | atom()
}
"""
@type human_workflow_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_content_policy() :: %{
"filters" => list(guardrail_content_filter()),
"tier" => guardrail_content_filters_tier()
}
"""
@type guardrail_content_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
routing_criteria() :: %{
"responseQualityDifference" => [float()]
}
"""
@type routing_criteria() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_object_doc() :: %{
"uri" => String.t() | atom()
}
"""
@type s3_object_doc() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_marketplace_model_endpoint_request() :: %{}
"""
@type get_marketplace_model_endpoint_request() :: %{}
@typedoc """
## Example:
delete_automated_reasoning_policy_build_workflow_request() :: %{
required("lastUpdatedAt") => non_neg_integer()
}
"""
@type delete_automated_reasoning_policy_build_workflow_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_check_satisfiable_finding() :: %{
"claimsFalseScenario" => automated_reasoning_check_scenario(),
"claimsTrueScenario" => automated_reasoning_check_scenario(),
"logicWarning" => automated_reasoning_check_logic_warning(),
"translation" => automated_reasoning_check_translation()
}
"""
@type automated_reasoning_check_satisfiable_finding() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_import_jobs_request() :: %{
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("statusEquals") => list(any())
}
"""
@type list_model_import_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_topics_tier_config() :: %{
"tierName" => list(any())
}
"""
@type guardrail_topics_tier_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_workflow_repair_content() :: %{
"annotations" => list(list())
}
"""
@type automated_reasoning_policy_build_workflow_repair_content() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_check_logic_warning() :: %{
"claims" => list(automated_reasoning_logic_statement()),
"premises" => list(automated_reasoning_logic_statement()),
"type" => list(any())
}
"""
@type automated_reasoning_check_logic_warning() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_contextual_grounding_filter_config() :: %{
"action" => list(any()),
"enabled" => [boolean()],
"threshold" => [float()],
"type" => list(any())
}
"""
@type guardrail_contextual_grounding_filter_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_custom_model_deployment_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("tags") => list(tag()),
required("modelArn") => String.t() | atom(),
required("modelDeploymentName") => String.t() | atom()
}
"""
@type create_custom_model_deployment_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_build_workflow_result_assets_request() :: %{
required("assetType") => list(any())
}
"""
@type get_automated_reasoning_policy_build_workflow_result_assets_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_model_customization_jobs_request() :: %{
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("statusEquals") => list(any())
}
"""
@type list_model_customization_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_foundation_model_agreement_offers_response() :: %{
"modelId" => String.t() | atom(),
"offers" => list(offer())
}
"""
@type list_foundation_model_agreement_offers_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_provisioned_model_throughputs_request() :: %{
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("modelArnEquals") => String.t() | atom(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("statusEquals") => list(any())
}
"""
@type list_provisioned_model_throughputs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_rule() :: %{
"id" => String.t() | atom(),
"policyVersionArn" => String.t() | atom()
}
"""
@type automated_reasoning_check_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_annotations_response() :: %{
"annotationSetHash" => String.t() | atom(),
"annotations" => list(list()),
"buildWorkflowId" => String.t() | atom(),
"name" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"updatedAt" => non_neg_integer()
}
"""
@type get_automated_reasoning_policy_annotations_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_definition_rule() :: %{
"alternateExpression" => String.t() | atom(),
"expression" => String.t() | atom(),
"id" => String.t() | atom()
}
"""
@type automated_reasoning_policy_definition_rule() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
pricing_term() :: %{
"rateCard" => list(dimensional_price_rate())
}
"""
@type pricing_term() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_custom_model_deployment_request() :: %{}
"""
@type delete_custom_model_deployment_request() :: %{}
@typedoc """
## Example:
get_automated_reasoning_policy_response() :: %{
"createdAt" => non_neg_integer(),
"definitionHash" => String.t() | atom(),
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"policyId" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"version" => String.t() | atom()
}
"""
@type get_automated_reasoning_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_guardrail_response() :: %{
"createdAt" => non_neg_integer(),
"guardrailArn" => String.t() | atom(),
"guardrailId" => String.t() | atom(),
"version" => String.t() | atom()
}
"""
@type create_guardrail_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_evaluation_job_request() :: %{}
"""
@type stop_evaluation_job_request() :: %{}
@typedoc """
## Example:
marketplace_model_endpoint() :: %{
"createdAt" => non_neg_integer(),
"endpointArn" => String.t() | atom(),
"endpointConfig" => list(),
"endpointStatus" => [String.t() | atom()],
"endpointStatusMessage" => [String.t() | atom()],
"modelSourceIdentifier" => String.t() | atom(),
"status" => list(any()),
"statusMessage" => [String.t() | atom()],
"updatedAt" => non_neg_integer()
}
"""
@type marketplace_model_endpoint() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_evaluation_custom_metric_config() :: %{
"customMetrics" => list(list()),
"evaluatorModelConfig" => custom_metric_evaluator_model_config()
}
"""
@type automated_evaluation_custom_metric_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_custom_model_deployment_request() :: %{}
"""
@type get_custom_model_deployment_request() :: %{}
@typedoc """
## Example:
evaluation_model_config_summary() :: %{
"bedrockModelIdentifiers" => list(String.t() | atom()),
"precomputedInferenceSourceIdentifiers" => list(String.t() | atom())
}
"""
@type evaluation_model_config_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
invocation_logs_config() :: %{
"invocationLogSource" => list(),
"requestMetadataFilters" => list(),
"usePromptResponse" => boolean()
}
"""
@type invocation_logs_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policy_build_workflows_response() :: %{
"automatedReasoningPolicyBuildWorkflowSummaries" => list(automated_reasoning_policy_build_workflow_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_automated_reasoning_policy_build_workflows_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
get_prompt_router_request() :: %{}
"""
@type get_prompt_router_request() :: %{}
@typedoc """
## Example:
agreement_availability() :: %{
"errorMessage" => [String.t() | atom()],
"status" => list(any())
}
"""
@type agreement_availability() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_rule_annotation() :: %{
"expression" => String.t() | atom()
}
"""
@type automated_reasoning_policy_add_rule_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
support_term() :: %{
"refundPolicyDescription" => [String.t() | atom()]
}
"""
@type support_term() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policy_test_results_response() :: %{
"nextToken" => String.t() | atom(),
"testResults" => list(automated_reasoning_policy_test_result())
}
"""
@type list_automated_reasoning_policy_test_results_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_inference_profiles_response() :: %{
"inferenceProfileSummaries" => list(inference_profile_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_inference_profiles_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_delete_rule_annotation() :: %{
"ruleId" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_rule_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_custom_model_response() :: %{
"modelArn" => String.t() | atom()
}
"""
@type create_custom_model_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_prompt_router_request() :: %{}
"""
@type delete_prompt_router_request() :: %{}
@typedoc """
## Example:
cloud_watch_config() :: %{
"largeDataDeliveryS3Config" => s3_config(),
"logGroupName" => String.t() | atom(),
"roleArn" => String.t() | atom()
}
"""
@type cloud_watch_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_inference_profile_request() :: %{}
"""
@type delete_inference_profile_request() :: %{}
@typedoc """
## Example:
automated_reasoning_policy_scenario() :: %{
"alternateExpression" => String.t() | atom(),
"expectedResult" => list(any()),
"expression" => String.t() | atom(),
"ruleIds" => list(String.t() | atom())
}
"""
@type automated_reasoning_policy_scenario() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
logging_config() :: %{
"cloudWatchConfig" => cloud_watch_config(),
"embeddingDataDeliveryEnabled" => [boolean()],
"imageDataDeliveryEnabled" => [boolean()],
"s3Config" => s3_config(),
"textDataDeliveryEnabled" => [boolean()],
"videoDataDeliveryEnabled" => [boolean()]
}
"""
@type logging_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("resourceARN") => String.t() | atom(),
required("tagKeys") => list(String.t() | atom())
}
"""
@type untag_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_metric_bedrock_evaluator_model() :: %{
"modelIdentifier" => String.t() | atom()
}
"""
@type custom_metric_bedrock_evaluator_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_type_mutation() :: %{
"type" => automated_reasoning_policy_definition_type()
}
"""
@type automated_reasoning_policy_update_type_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
status_details() :: %{
"dataProcessingDetails" => data_processing_details(),
"trainingDetails" => training_details(),
"validationDetails" => validation_details()
}
"""
@type status_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_inference_profile_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("tags") => list(tag()),
required("inferenceProfileName") => String.t() | atom(),
required("modelSource") => list()
}
"""
@type create_inference_profile_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_provisioned_model_throughputs_response() :: %{
"nextToken" => String.t() | atom(),
"provisionedModelSummaries" => list(provisioned_model_summary())
}
"""
@type list_provisioned_model_throughputs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
provisioned_model_summary() :: %{
"commitmentDuration" => list(any()),
"commitmentExpirationTime" => non_neg_integer(),
"creationTime" => non_neg_integer(),
"desiredModelArn" => String.t() | atom(),
"desiredModelUnits" => integer(),
"foundationModelArn" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"modelArn" => String.t() | atom(),
"modelUnits" => integer(),
"provisionedModelArn" => String.t() | atom(),
"provisionedModelName" => String.t() | atom(),
"status" => list(any())
}
"""
@type provisioned_model_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
retrieve_and_generate_configuration() :: %{
"externalSourcesConfiguration" => external_sources_retrieve_and_generate_configuration(),
"knowledgeBaseConfiguration" => knowledge_base_retrieve_and_generate_configuration(),
"type" => list(any())
}
"""
@type retrieve_and_generate_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_variable_mutation() :: %{
"variable" => automated_reasoning_policy_definition_variable()
}
"""
@type automated_reasoning_policy_update_variable_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_workflow_document() :: %{
"document" => [binary()],
"documentContentType" => list(any()),
"documentDescription" => String.t() | atom(),
"documentName" => String.t() | atom()
}
"""
@type automated_reasoning_policy_build_workflow_document() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_model_copy_job_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("modelKmsKeyId") => String.t() | atom(),
optional("targetModelTags") => list(tag()),
required("sourceModelArn") => String.t() | atom(),
required("targetModelName") => String.t() | atom()
}
"""
@type create_model_copy_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
prompt_router_summary() :: %{
"createdAt" => non_neg_integer(),
"description" => String.t() | atom(),
"fallbackModel" => prompt_router_target_model(),
"models" => list(prompt_router_target_model()),
"promptRouterArn" => String.t() | atom(),
"promptRouterName" => String.t() | atom(),
"routingCriteria" => routing_criteria(),
"status" => list(any()),
"type" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type prompt_router_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_automated_reasoning_policy_test_case_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("confidenceThreshold") => float(),
optional("kmsKeyArn") => String.t() | atom(),
optional("queryContent") => String.t() | atom(),
required("expectedAggregatedFindingsResult") => list(any()),
required("guardContent") => String.t() | atom(),
required("lastUpdatedAt") => non_neg_integer()
}
"""
@type update_automated_reasoning_policy_test_case_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_custom_model_deployments_request() :: %{
optional("createdAfter") => non_neg_integer(),
optional("createdBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("modelArnEquals") => String.t() | atom(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("statusEquals") => list(any())
}
"""
@type list_custom_model_deployments_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
model_import_job_summary() :: %{
"creationTime" => non_neg_integer(),
"endTime" => non_neg_integer(),
"importedModelArn" => String.t() | atom(),
"importedModelName" => String.t() | atom(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"status" => list(any())
}
"""
@type model_import_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_managed_words_config() :: %{
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"type" => list(any())
}
"""
@type guardrail_managed_words_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_word() :: %{
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"text" => [String.t() | atom()]
}
"""
@type guardrail_word() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_automated_reasoning_policy_response() :: %{
"createdAt" => non_neg_integer(),
"definitionHash" => String.t() | atom(),
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"version" => String.t() | atom()
}
"""
@type create_automated_reasoning_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_from_rule_feedback_annotation() :: %{
"feedback" => String.t() | atom(),
"ruleIds" => list(String.t() | atom())
}
"""
@type automated_reasoning_policy_update_from_rule_feedback_annotation() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_check_translation_option() :: %{
"translations" => list(automated_reasoning_check_translation())
}
"""
@type automated_reasoning_check_translation_option() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
inference_profile_model() :: %{
"modelArn" => String.t() | atom()
}
"""
@type inference_profile_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_type_value() :: %{
"description" => String.t() | atom(),
"newValue" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type automated_reasoning_policy_update_type_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
inference_profile_summary() :: %{
"createdAt" => non_neg_integer(),
"description" => String.t() | atom(),
"inferenceProfileArn" => String.t() | atom(),
"inferenceProfileId" => String.t() | atom(),
"inferenceProfileName" => String.t() | atom(),
"models" => list(inference_profile_model()),
"status" => list(any()),
"type" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type inference_profile_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_model_invocation_job_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("tags") => list(tag()),
optional("timeoutDurationInHours") => integer(),
optional("vpcConfig") => vpc_config(),
required("inputDataConfig") => list(),
required("jobName") => String.t() | atom(),
required("modelId") => String.t() | atom(),
required("outputDataConfig") => list(),
required("roleArn") => String.t() | atom()
}
"""
@type create_model_invocation_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_automated_reasoning_policy_test_case_request() :: %{
required("lastUpdatedAt") => non_neg_integer()
}
"""
@type delete_automated_reasoning_policy_test_case_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_provisioned_model_throughput_response() :: %{
"commitmentDuration" => list(any()),
"commitmentExpirationTime" => non_neg_integer(),
"creationTime" => non_neg_integer(),
"desiredModelArn" => String.t() | atom(),
"desiredModelUnits" => integer(),
"failureMessage" => String.t() | atom(),
"foundationModelArn" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"modelArn" => String.t() | atom(),
"modelUnits" => integer(),
"provisionedModelArn" => String.t() | atom(),
"provisionedModelName" => String.t() | atom(),
"status" => list(any())
}
"""
@type get_provisioned_model_throughput_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
model_invocation_job_s3_output_data_config() :: %{
"s3BucketOwner" => String.t() | atom(),
"s3EncryptionKeyId" => String.t() | atom(),
"s3Uri" => String.t() | atom()
}
"""
@type model_invocation_job_s3_output_data_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_automated_reasoning_policy_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("policyDefinition") => automated_reasoning_policy_definition(),
optional("tags") => list(tag()),
required("name") => String.t() | atom()
}
"""
@type create_automated_reasoning_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_automated_reasoning_policy_request() :: %{
optional("description") => String.t() | atom(),
optional("name") => String.t() | atom(),
required("policyDefinition") => automated_reasoning_policy_definition()
}
"""
@type update_automated_reasoning_policy_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
bedrock_evaluator_model() :: %{
"modelIdentifier" => String.t() | atom()
}
"""
@type bedrock_evaluator_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_definition_type() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"values" => list(automated_reasoning_policy_definition_type_value())
}
"""
@type automated_reasoning_policy_definition_type() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_use_case_for_model_access_response() :: %{
"formData" => binary()
}
"""
@type get_use_case_for_model_access_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
knowledge_base_retrieve_and_generate_configuration() :: %{
"generationConfiguration" => generation_configuration(),
"knowledgeBaseId" => String.t() | atom(),
"modelArn" => String.t() | atom(),
"orchestrationConfiguration" => orchestration_configuration(),
"retrievalConfiguration" => knowledge_base_retrieval_configuration()
}
"""
@type knowledge_base_retrieve_and_generate_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_foundation_model_request() :: %{}
"""
@type get_foundation_model_request() :: %{}
@typedoc """
## Example:
automated_reasoning_policy_delete_variable_annotation() :: %{
"name" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_variable_annotation() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_custom_model_deployments_response() :: %{
"modelDeploymentSummaries" => list(custom_model_deployment_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_custom_model_deployments_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deregister_marketplace_model_endpoint_response() :: %{}
"""
@type deregister_marketplace_model_endpoint_response() :: %{}
@typedoc """
## Example:
imported_model_summary() :: %{
"creationTime" => non_neg_integer(),
"instructSupported" => boolean(),
"modelArchitecture" => String.t() | atom(),
"modelArn" => String.t() | atom(),
"modelName" => String.t() | atom()
}
"""
@type imported_model_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_imported_model_request() :: %{}
"""
@type get_imported_model_request() :: %{}
@typedoc """
## Example:
get_automated_reasoning_policy_build_workflow_request() :: %{}
"""
@type get_automated_reasoning_policy_build_workflow_request() :: %{}
@typedoc """
## Example:
create_automated_reasoning_policy_version_response() :: %{
"createdAt" => non_neg_integer(),
"definitionHash" => String.t() | atom(),
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"version" => String.t() | atom()
}
"""
@type create_automated_reasoning_policy_version_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_model_customization_job_response() :: %{}
"""
@type stop_model_customization_job_response() :: %{}
@typedoc """
## Example:
conflict_exception() :: %{
"message" => String.t() | atom()
}
"""
@type conflict_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
resource_not_found_exception() :: %{
"message" => String.t() | atom()
}
"""
@type resource_not_found_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
query_transformation_configuration() :: %{
"type" => list(any())
}
"""
@type query_transformation_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
retrieve_config() :: %{
"knowledgeBaseId" => String.t() | atom(),
"knowledgeBaseRetrievalConfiguration" => knowledge_base_retrieval_configuration()
}
"""
@type retrieve_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_disjoint_rule_set() :: %{
"rules" => list(String.t() | atom()),
"variables" => list(String.t() | atom())
}
"""
@type automated_reasoning_policy_disjoint_rule_set() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_copy_job_request() :: %{}
"""
@type get_model_copy_job_request() :: %{}
@typedoc """
## Example:
guardrail_content_filter_config() :: %{
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"inputModalities" => list(list(any())()),
"inputStrength" => list(any()),
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"outputModalities" => list(list(any())()),
"outputStrength" => list(any()),
"type" => list(any())
}
"""
@type guardrail_content_filter_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_log_entry() :: %{
"annotation" => list(),
"buildSteps" => list(automated_reasoning_policy_build_step()),
"status" => list(any())
}
"""
@type automated_reasoning_policy_build_log_entry() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_valid_finding() :: %{
"claimsTrueScenario" => automated_reasoning_check_scenario(),
"logicWarning" => automated_reasoning_check_logic_warning(),
"supportingRules" => list(automated_reasoning_check_rule()),
"translation" => automated_reasoning_check_translation()
}
"""
@type automated_reasoning_check_valid_finding() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
data_processing_details() :: %{
"creationTime" => non_neg_integer(),
"lastModifiedTime" => non_neg_integer(),
"status" => list(any())
}
"""
@type data_processing_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policy_test_results_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_automated_reasoning_policy_test_results_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
start_automated_reasoning_policy_test_workflow_response() :: %{
"policyArn" => String.t() | atom()
}
"""
@type start_automated_reasoning_policy_test_workflow_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_guardrails_response() :: %{
"guardrails" => list(guardrail_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_guardrails_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_metric_definition() :: %{
"instructions" => String.t() | atom(),
"name" => String.t() | atom(),
"ratingScale" => list(rating_scale_item())
}
"""
@type custom_metric_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policy_build_workflows_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_automated_reasoning_policy_build_workflows_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
field_for_reranking() :: %{
"fieldName" => [String.t() | atom()]
}
"""
@type field_for_reranking() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
tag() :: %{
"key" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type tag() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_inference_profile_request() :: %{}
"""
@type get_inference_profile_request() :: %{}
@typedoc """
## Example:
knowledge_base_retrieval_configuration() :: %{
"vectorSearchConfiguration" => knowledge_base_vector_search_configuration()
}
"""
@type knowledge_base_retrieval_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_marketplace_model_endpoint_request() :: %{
optional("acceptEula") => boolean(),
optional("clientRequestToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("endpointConfig") => list(),
required("endpointName") => String.t() | atom(),
required("modelSourceIdentifier") => String.t() | atom()
}
"""
@type create_marketplace_model_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_provisioned_model_throughput_request() :: %{}
"""
@type delete_provisioned_model_throughput_request() :: %{}
@typedoc """
## Example:
evaluation_dataset_metric_config() :: %{
"dataset" => evaluation_dataset(),
"metricNames" => list(String.t() | atom()),
"taskType" => list(any())
}
"""
@type evaluation_dataset_metric_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_annotations_request() :: %{}
"""
@type get_automated_reasoning_policy_annotations_request() :: %{}
@typedoc """
## Example:
guardrail_content_filter() :: %{
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"inputModalities" => list(list(any())()),
"inputStrength" => list(any()),
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"outputModalities" => list(list(any())()),
"outputStrength" => list(any()),
"type" => list(any())
}
"""
@type guardrail_content_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_from_scenario_feedback_annotation() :: %{
"feedback" => String.t() | atom(),
"ruleIds" => list(String.t() | atom()),
"scenarioExpression" => String.t() | atom()
}
"""
@type automated_reasoning_policy_update_from_scenario_feedback_annotation() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
guardrail_content_filters_tier() :: %{
"tierName" => list(any())
}
"""
@type guardrail_content_filters_tier() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_automated_reasoning_policy_response() :: %{
"definitionHash" => String.t() | atom(),
"name" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"updatedAt" => non_neg_integer()
}
"""
@type update_automated_reasoning_policy_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_provisioned_model_throughput_response() :: %{
"provisionedModelArn" => String.t() | atom()
}
"""
@type create_provisioned_model_throughput_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_quota_exceeded_exception() :: %{
"message" => String.t() | atom()
}
"""
@type service_quota_exceeded_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_model_deployment_summary() :: %{
"createdAt" => non_neg_integer(),
"customModelDeploymentArn" => String.t() | atom(),
"customModelDeploymentName" => String.t() | atom(),
"failureMessage" => String.t() | atom(),
"lastUpdatedAt" => non_neg_integer(),
"modelArn" => String.t() | atom(),
"status" => list(any())
}
"""
@type custom_model_deployment_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_config() :: %{
"bucketName" => String.t() | atom(),
"keyPrefix" => String.t() | atom()
}
"""
@type s3_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_invocation_jobs_response() :: %{
"invocationJobSummaries" => list(model_invocation_job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_model_invocation_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_custom_model_response() :: %{
"baseModelArn" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"customizationConfig" => list(),
"customizationType" => list(any()),
"failureMessage" => String.t() | atom(),
"hyperParameters" => map(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"modelArn" => String.t() | atom(),
"modelKmsKeyArn" => String.t() | atom(),
"modelName" => String.t() | atom(),
"modelStatus" => list(any()),
"outputDataConfig" => output_data_config(),
"trainingDataConfig" => training_data_config(),
"trainingMetrics" => training_metrics(),
"validationDataConfig" => validation_data_config(),
"validationMetrics" => list(validator_metric())
}
"""
@type get_custom_model_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_delete_variable_mutation() :: %{
"name" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_variable_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
model_copy_job_summary() :: %{
"creationTime" => non_neg_integer(),
"failureMessage" => String.t() | atom(),
"jobArn" => String.t() | atom(),
"sourceAccountId" => String.t() | atom(),
"sourceModelArn" => String.t() | atom(),
"sourceModelName" => String.t() | atom(),
"status" => list(any()),
"targetModelArn" => String.t() | atom(),
"targetModelKmsKeyArn" => String.t() | atom(),
"targetModelName" => String.t() | atom(),
"targetModelTags" => list(tag())
}
"""
@type model_copy_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_delete_type_mutation() :: %{
"name" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_type_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_contextual_grounding_filter() :: %{
"action" => list(any()),
"enabled" => [boolean()],
"threshold" => [float()],
"type" => list(any())
}
"""
@type guardrail_contextual_grounding_filter() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_provisioned_model_throughput_request() :: %{
optional("desiredModelId") => String.t() | atom(),
optional("desiredProvisionedModelName") => String.t() | atom()
}
"""
@type update_provisioned_model_throughput_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_build_workflow_response() :: %{
"buildWorkflowId" => String.t() | atom(),
"buildWorkflowType" => list(any()),
"createdAt" => non_neg_integer(),
"documentContentType" => list(any()),
"documentDescription" => String.t() | atom(),
"documentName" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"status" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type get_automated_reasoning_policy_build_workflow_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
guardrail_managed_words() :: %{
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"type" => list(any())
}
"""
@type guardrail_managed_words() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_custom_model_deployment_response() :: %{}
"""
@type delete_custom_model_deployment_response() :: %{}
@typedoc """
## Example:
guardrail_content_policy_config() :: %{
"filtersConfig" => list(guardrail_content_filter_config()),
"tierConfig" => guardrail_content_filters_tier_config()
}
"""
@type guardrail_content_policy_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_output_data_config() :: %{
"s3Uri" => String.t() | atom()
}
"""
@type evaluation_output_data_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_precomputed_inference_source() :: %{
"inferenceSourceIdentifier" => String.t() | atom()
}
"""
@type evaluation_precomputed_inference_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_variable_mutation() :: %{
"variable" => automated_reasoning_policy_definition_variable()
}
"""
@type automated_reasoning_policy_add_variable_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policy_test_cases_response() :: %{
"nextToken" => String.t() | atom(),
"testCases" => list(automated_reasoning_policy_test_case())
}
"""
@type list_automated_reasoning_policy_test_cases_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
rating_scale_item() :: %{
"definition" => String.t() | atom(),
"value" => list()
}
"""
@type rating_scale_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_provisioned_model_throughput_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("commitmentDuration") => list(any()),
optional("tags") => list(tag()),
required("modelId") => String.t() | atom(),
required("modelUnits") => integer(),
required("provisionedModelName") => String.t() | atom()
}
"""
@type create_provisioned_model_throughput_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_prompt_router_response() :: %{}
"""
@type delete_prompt_router_response() :: %{}
@typedoc """
## Example:
delete_foundation_model_agreement_request() :: %{
required("modelId") => String.t() | atom()
}
"""
@type delete_foundation_model_agreement_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_ingest_content_annotation() :: %{
"content" => String.t() | atom()
}
"""
@type automated_reasoning_policy_ingest_content_annotation() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
create_automated_reasoning_policy_test_case_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("confidenceThreshold") => float(),
optional("queryContent") => String.t() | atom(),
required("expectedAggregatedFindingsResult") => list(any()),
required("guardContent") => String.t() | atom()
}
"""
@type create_automated_reasoning_policy_test_case_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
teacher_model_config() :: %{
"maxResponseLengthForInference" => [integer()],
"teacherModelIdentifier" => String.t() | atom()
}
"""
@type teacher_model_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validation_details() :: %{
"creationTime" => non_neg_integer(),
"lastModifiedTime" => non_neg_integer(),
"status" => list(any())
}
"""
@type validation_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
vpc_config() :: %{
"securityGroupIds" => list(String.t() | atom()),
"subnetIds" => list(String.t() | atom())
}
"""
@type vpc_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_cross_region_details() :: %{
"guardrailProfileArn" => String.t() | atom(),
"guardrailProfileId" => String.t() | atom()
}
"""
@type guardrail_cross_region_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
external_sources_retrieve_and_generate_configuration() :: %{
"generationConfiguration" => external_sources_generation_configuration(),
"modelArn" => String.t() | atom(),
"sources" => list(external_source())
}
"""
@type external_sources_retrieve_and_generate_configuration() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
delete_inference_profile_response() :: %{}
"""
@type delete_inference_profile_response() :: %{}
@typedoc """
## Example:
batch_delete_evaluation_job_response() :: %{
"errors" => list(batch_delete_evaluation_job_error()),
"evaluationJobs" => list(batch_delete_evaluation_job_item())
}
"""
@type batch_delete_evaluation_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_prompt_router_response() :: %{
"createdAt" => non_neg_integer(),
"description" => String.t() | atom(),
"fallbackModel" => prompt_router_target_model(),
"models" => list(prompt_router_target_model()),
"promptRouterArn" => String.t() | atom(),
"promptRouterName" => String.t() | atom(),
"routingCriteria" => routing_criteria(),
"status" => list(any()),
"type" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type get_prompt_router_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_marketplace_model_endpoint_response() :: %{
"marketplaceModelEndpoint" => marketplace_model_endpoint()
}
"""
@type update_marketplace_model_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_pii_entity() :: %{
"action" => list(any()),
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"type" => list(any())
}
"""
@type guardrail_pii_entity() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_cross_region_config() :: %{
"guardrailProfileIdentifier" => String.t() | atom()
}
"""
@type guardrail_cross_region_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"tags" => list(tag())
}
"""
@type list_tags_for_resource_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_imported_models_request() :: %{
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("nameContains") => String.t() | atom(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any())
}
"""
@type list_imported_models_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_model_invocation_logging_configuration_response() :: %{}
"""
@type delete_model_invocation_logging_configuration_response() :: %{}
@typedoc """
## Example:
training_metrics() :: %{
"trainingLoss" => float()
}
"""
@type training_metrics() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_use_case_for_model_access_response() :: %{}
"""
@type put_use_case_for_model_access_response() :: %{}
@typedoc """
## Example:
update_guardrail_request() :: %{
optional("automatedReasoningPolicyConfig") => guardrail_automated_reasoning_policy_config(),
optional("contentPolicyConfig") => guardrail_content_policy_config(),
optional("contextualGroundingPolicyConfig") => guardrail_contextual_grounding_policy_config(),
optional("crossRegionConfig") => guardrail_cross_region_config(),
optional("description") => String.t() | atom(),
optional("kmsKeyId") => String.t() | atom(),
optional("sensitiveInformationPolicyConfig") => guardrail_sensitive_information_policy_config(),
optional("topicPolicyConfig") => guardrail_topic_policy_config(),
optional("wordPolicyConfig") => guardrail_word_policy_config(),
required("blockedInputMessaging") => String.t() | atom(),
required("blockedOutputsMessaging") => String.t() | atom(),
required("name") => String.t() | atom()
}
"""
@type update_guardrail_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_import_job_request() :: %{}
"""
@type get_model_import_job_request() :: %{}
@typedoc """
## Example:
automated_reasoning_check_input_text_reference() :: %{
"text" => String.t() | atom()
}
"""
@type automated_reasoning_check_input_text_reference() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_import_job_response() :: %{
"creationTime" => non_neg_integer(),
"endTime" => non_neg_integer(),
"failureMessage" => String.t() | atom(),
"importedModelArn" => String.t() | atom(),
"importedModelKmsKeyArn" => String.t() | atom(),
"importedModelName" => String.t() | atom(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"modelDataSource" => list(),
"roleArn" => String.t() | atom(),
"status" => list(any()),
"vpcConfig" => vpc_config()
}
"""
@type get_model_import_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
model_invocation_job_s3_input_data_config() :: %{
"s3BucketOwner" => String.t() | atom(),
"s3InputFormat" => list(any()),
"s3Uri" => String.t() | atom()
}
"""
@type model_invocation_job_s3_input_data_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_custom_model_request() :: %{}
"""
@type get_custom_model_request() :: %{}
@typedoc """
## Example:
automated_reasoning_policy_add_variable_annotation() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type automated_reasoning_policy_add_variable_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
vector_search_reranking_configuration() :: %{
"bedrockRerankingConfiguration" => vector_search_bedrock_reranking_configuration(),
"type" => list(any())
}
"""
@type vector_search_reranking_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
byte_content_doc() :: %{
"contentType" => String.t() | atom(),
"data" => binary(),
"identifier" => String.t() | atom()
}
"""
@type byte_content_doc() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
legal_term() :: %{
"url" => [String.t() | atom()]
}
"""
@type legal_term() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_imported_models_response() :: %{
"modelSummaries" => list(imported_model_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_imported_models_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
service_unavailable_exception() :: %{
"message" => String.t() | atom()
}
"""
@type service_unavailable_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_rule_mutation() :: %{
"rule" => automated_reasoning_policy_definition_rule()
}
"""
@type automated_reasoning_policy_update_rule_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_next_scenario_response() :: %{
"policyArn" => String.t() | atom(),
"scenario" => automated_reasoning_policy_scenario()
}
"""
@type get_automated_reasoning_policy_next_scenario_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
external_sources_generation_configuration() :: %{
"additionalModelRequestFields" => map(),
"guardrailConfiguration" => guardrail_configuration(),
"kbInferenceConfig" => kb_inference_config(),
"promptTemplate" => prompt_template()
}
"""
@type external_sources_generation_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_customization_job_request() :: %{}
"""
@type get_model_customization_job_request() :: %{}
@typedoc """
## Example:
human_evaluation_custom_metric() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"ratingMethod" => String.t() | atom()
}
"""
@type human_evaluation_custom_metric() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_prompt_router_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("description") => String.t() | atom(),
optional("tags") => list(tag()),
required("fallbackModel") => prompt_router_target_model(),
required("models") => list(prompt_router_target_model()),
required("promptRouterName") => String.t() | atom(),
required("routingCriteria") => routing_criteria()
}
"""
@type create_prompt_router_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cancel_automated_reasoning_policy_build_workflow_response() :: %{}
"""
@type cancel_automated_reasoning_policy_build_workflow_response() :: %{}
@typedoc """
## Example:
knowledge_base_vector_search_configuration() :: %{
"filter" => list(),
"implicitFilterConfiguration" => implicit_filter_configuration(),
"numberOfResults" => [integer()],
"overrideSearchType" => list(any()),
"rerankingConfiguration" => vector_search_reranking_configuration()
}
"""
@type knowledge_base_vector_search_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_automated_reasoning_policy() :: %{
"confidenceThreshold" => float(),
"policies" => list(String.t() | atom())
}
"""
@type guardrail_automated_reasoning_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_request() :: %{}
"""
@type get_automated_reasoning_policy_request() :: %{}
@typedoc """
## Example:
get_model_invocation_logging_configuration_request() :: %{}
"""
@type get_model_invocation_logging_configuration_request() :: %{}
@typedoc """
## Example:
delete_automated_reasoning_policy_request() :: %{}
"""
@type delete_automated_reasoning_policy_request() :: %{}
@typedoc """
## Example:
filter_attribute() :: %{
"key" => String.t() | atom(),
"value" => any()
}
"""
@type filter_attribute() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_marketplace_model_endpoint_response() :: %{}
"""
@type delete_marketplace_model_endpoint_response() :: %{}
@typedoc """
## Example:
get_automated_reasoning_policy_test_result_response() :: %{
"testResult" => automated_reasoning_policy_test_result()
}
"""
@type get_automated_reasoning_policy_test_result_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_imported_model_response() :: %{}
"""
@type delete_imported_model_response() :: %{}
@typedoc """
## Example:
list_foundation_models_request() :: %{
optional("byCustomizationType") => list(any()),
optional("byInferenceType") => list(any()),
optional("byOutputModality") => list(any()),
optional("byProvider") => String.t() | atom()
}
"""
@type list_foundation_models_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_word_config() :: %{
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"text" => [String.t() | atom()]
}
"""
@type guardrail_word_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_automated_reasoning_policy_test_case_request() :: %{}
"""
@type get_automated_reasoning_policy_test_case_request() :: %{}
@typedoc """
## Example:
guardrail_sensitive_information_policy() :: %{
"piiEntities" => list(guardrail_pii_entity()),
"regexes" => list(guardrail_regex())
}
"""
@type guardrail_sensitive_information_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
implicit_filter_configuration() :: %{
"metadataAttributes" => list(metadata_attribute_schema()),
"modelArn" => String.t() | atom()
}
"""
@type implicit_filter_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
foundation_model_lifecycle() :: %{
"status" => list(any())
}
"""
@type foundation_model_lifecycle() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_marketplace_model_endpoint_response() :: %{
"marketplaceModelEndpoint" => marketplace_model_endpoint()
}
"""
@type create_marketplace_model_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_contextual_grounding_policy_config() :: %{
"filtersConfig" => list(guardrail_contextual_grounding_filter_config())
}
"""
@type guardrail_contextual_grounding_policy_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_use_case_for_model_access_request() :: %{
required("formData") => binary()
}
"""
@type put_use_case_for_model_access_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_rag_config_summary() :: %{
"bedrockKnowledgeBaseIdentifiers" => list(String.t() | atom()),
"precomputedRagSourceIdentifiers" => list(String.t() | atom())
}
"""
@type evaluation_rag_config_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_imported_model_request() :: %{}
"""
@type delete_imported_model_request() :: %{}
@typedoc """
## Example:
distillation_config() :: %{
"teacherModelConfig" => teacher_model_config()
}
"""
@type distillation_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
vector_search_bedrock_reranking_configuration() :: %{
"metadataConfiguration" => metadata_configuration_for_reranking(),
"modelConfiguration" => vector_search_bedrock_reranking_model_configuration(),
"numberOfRerankedResults" => [integer()]
}
"""
@type vector_search_bedrock_reranking_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_automated_reasoning_policy_annotations_request() :: %{
required("annotations") => list(list()),
required("lastUpdatedAnnotationSetHash") => String.t() | atom()
}
"""
@type update_automated_reasoning_policy_annotations_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_foundation_model_agreement_offers_request() :: %{
optional("offerType") => list(any())
}
"""
@type list_foundation_model_agreement_offers_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_step_message() :: %{
"message" => [String.t() | atom()],
"messageType" => list(any())
}
"""
@type automated_reasoning_policy_build_step_message() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
internal_server_exception() :: %{
"message" => String.t() | atom()
}
"""
@type internal_server_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_copy_jobs_response() :: %{
"modelCopyJobSummaries" => list(model_copy_job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_model_copy_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_log() :: %{
"entries" => list(automated_reasoning_policy_build_log_entry())
}
"""
@type automated_reasoning_policy_build_log() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_type_mutation() :: %{
"type" => automated_reasoning_policy_definition_type()
}
"""
@type automated_reasoning_policy_add_type_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
cancel_automated_reasoning_policy_build_workflow_request() :: %{}
"""
@type cancel_automated_reasoning_policy_build_workflow_request() :: %{}
@typedoc """
## Example:
delete_guardrail_response() :: %{}
"""
@type delete_guardrail_response() :: %{}
@typedoc """
## Example:
validation_data_config() :: %{
"validators" => list(validator())
}
"""
@type validation_data_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_delete_evaluation_job_item() :: %{
"jobIdentifier" => String.t() | atom(),
"jobStatus" => list(any())
}
"""
@type batch_delete_evaluation_job_item() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_model_invocation_job_response() :: %{}
"""
@type stop_model_invocation_job_response() :: %{}
@typedoc """
## Example:
list_prompt_routers_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("type") => list(any())
}
"""
@type list_prompt_routers_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_provisioned_model_throughput_response() :: %{}
"""
@type update_provisioned_model_throughput_response() :: %{}
@typedoc """
## Example:
start_automated_reasoning_policy_test_workflow_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("testCaseIds") => list(String.t() | atom())
}
"""
@type start_automated_reasoning_policy_test_workflow_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
guardrail_regex_config() :: %{
"action" => list(any()),
"description" => [String.t() | atom()],
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"name" => [String.t() | atom()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"pattern" => [String.t() | atom()]
}
"""
@type guardrail_regex_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_model_invocation_logging_configuration_request() :: %{
required("loggingConfig") => logging_config()
}
"""
@type put_model_invocation_logging_configuration_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_scenario() :: %{
"statements" => list(automated_reasoning_logic_statement())
}
"""
@type automated_reasoning_check_scenario() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_metric_evaluator_model_config() :: %{
"bedrockEvaluatorModels" => list(custom_metric_bedrock_evaluator_model())
}
"""
@type custom_metric_evaluator_model_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_foundation_model_agreement_request() :: %{
required("modelId") => String.t() | atom(),
required("offerToken") => String.t() | atom()
}
"""
@type create_foundation_model_agreement_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_customization_jobs_response() :: %{
"modelCustomizationJobSummaries" => list(model_customization_job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_model_customization_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_foundation_models_response() :: %{
"modelSummaries" => list(foundation_model_summary())
}
"""
@type list_foundation_models_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_custom_model_deployment_response() :: %{
"createdAt" => non_neg_integer(),
"customModelDeploymentArn" => String.t() | atom(),
"description" => String.t() | atom(),
"failureMessage" => String.t() | atom(),
"lastUpdatedAt" => non_neg_integer(),
"modelArn" => String.t() | atom(),
"modelDeploymentName" => String.t() | atom(),
"status" => list(any())
}
"""
@type get_custom_model_deployment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_foundation_model_availability_response() :: %{
"agreementAvailability" => agreement_availability(),
"authorizationStatus" => list(any()),
"entitlementAvailability" => list(any()),
"modelId" => String.t() | atom(),
"regionAvailability" => list(any())
}
"""
@type get_foundation_model_availability_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
orchestration_configuration() :: %{
"queryTransformationConfiguration" => query_transformation_configuration()
}
"""
@type orchestration_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
prompt_template() :: %{
"textPromptTemplate" => String.t() | atom()
}
"""
@type prompt_template() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
access_denied_exception() :: %{
"message" => String.t() | atom()
}
"""
@type access_denied_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_imported_model_response() :: %{
"creationTime" => non_neg_integer(),
"customModelUnits" => custom_model_units(),
"instructSupported" => boolean(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"modelArchitecture" => [String.t() | atom()],
"modelArn" => String.t() | atom(),
"modelDataSource" => list(),
"modelKmsKeyArn" => String.t() | atom(),
"modelName" => String.t() | atom()
}
"""
@type get_imported_model_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_invocation_job_request() :: %{}
"""
@type get_model_invocation_job_request() :: %{}
@typedoc """
## Example:
delete_automated_reasoning_policy_response() :: %{}
"""
@type delete_automated_reasoning_policy_response() :: %{}
@typedoc """
## Example:
delete_automated_reasoning_policy_build_workflow_response() :: %{}
"""
@type delete_automated_reasoning_policy_build_workflow_response() :: %{}
@typedoc """
## Example:
create_model_customization_job_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("customModelKmsKeyId") => String.t() | atom(),
optional("customModelTags") => list(tag()),
optional("customizationConfig") => list(),
optional("customizationType") => list(any()),
optional("hyperParameters") => map(),
optional("jobTags") => list(tag()),
optional("validationDataConfig") => validation_data_config(),
optional("vpcConfig") => vpc_config(),
required("baseModelIdentifier") => String.t() | atom(),
required("customModelName") => String.t() | atom(),
required("jobName") => String.t() | atom(),
required("outputDataConfig") => output_data_config(),
required("roleArn") => String.t() | atom(),
required("trainingDataConfig") => training_data_config()
}
"""
@type create_model_customization_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
generation_configuration() :: %{
"additionalModelRequestFields" => map(),
"guardrailConfiguration" => guardrail_configuration(),
"kbInferenceConfig" => kb_inference_config(),
"promptTemplate" => prompt_template()
}
"""
@type generation_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_use_case_for_model_access_request() :: %{}
"""
@type get_use_case_for_model_access_request() :: %{}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
create_prompt_router_response() :: %{
"promptRouterArn" => String.t() | atom()
}
"""
@type create_prompt_router_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_evaluation_job_request() :: %{
optional("applicationType") => list(any()),
optional("clientRequestToken") => String.t() | atom(),
optional("customerEncryptionKeyId") => String.t() | atom(),
optional("jobDescription") => String.t() | atom(),
optional("jobTags") => list(tag()),
required("evaluationConfig") => list(),
required("inferenceConfig") => list(),
required("jobName") => String.t() | atom(),
required("outputDataConfig") => evaluation_output_data_config(),
required("roleArn") => String.t() | atom()
}
"""
@type create_evaluation_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_no_translations_finding() :: %{}
"""
@type automated_reasoning_check_no_translations_finding() :: %{}
@typedoc """
## Example:
get_marketplace_model_endpoint_response() :: %{
"marketplaceModelEndpoint" => marketplace_model_endpoint()
}
"""
@type get_marketplace_model_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_custom_model_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("modelKmsKeyArn") => String.t() | atom(),
optional("modelTags") => list(tag()),
optional("roleArn") => String.t() | atom(),
required("modelName") => String.t() | atom(),
required("modelSourceConfig") => list()
}
"""
@type create_custom_model_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_definition_quality_report() :: %{
"conflictingRules" => list(String.t() | atom()),
"disjointRuleSets" => list(automated_reasoning_policy_disjoint_rule_set()),
"ruleCount" => [integer()],
"typeCount" => [integer()],
"unusedTypeValues" => list(automated_reasoning_policy_definition_type_value_pair()),
"unusedTypes" => list(String.t() | atom()),
"unusedVariables" => list(String.t() | atom()),
"variableCount" => [integer()]
}
"""
@type automated_reasoning_policy_definition_quality_report() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_policy_definition_variable() :: %{
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"type" => String.t() | atom()
}
"""
@type automated_reasoning_policy_definition_variable() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
training_details() :: %{
"creationTime" => non_neg_integer(),
"lastModifiedTime" => non_neg_integer(),
"status" => list(any())
}
"""
@type training_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_word_policy_config() :: %{
"managedWordListsConfig" => list(guardrail_managed_words_config()),
"wordsConfig" => list(guardrail_word_config())
}
"""
@type guardrail_word_policy_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
export_automated_reasoning_policy_version_request() :: %{}
"""
@type export_automated_reasoning_policy_version_request() :: %{}
@typedoc """
## Example:
automated_reasoning_check_translation() :: %{
"claims" => list(automated_reasoning_logic_statement()),
"confidence" => float(),
"premises" => list(automated_reasoning_logic_statement()),
"untranslatedClaims" => list(automated_reasoning_check_input_text_reference()),
"untranslatedPremises" => list(automated_reasoning_check_input_text_reference())
}
"""
@type automated_reasoning_check_translation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validator_metric() :: %{
"validationLoss" => float()
}
"""
@type validator_metric() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_automated_reasoning_policy_test_case_response() :: %{
"policyArn" => String.t() | atom(),
"testCaseId" => String.t() | atom()
}
"""
@type create_automated_reasoning_policy_test_case_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
list_evaluation_jobs_response() :: %{
"jobSummaries" => list(evaluation_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_evaluation_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_sensitive_information_policy_config() :: %{
"piiEntitiesConfig" => list(guardrail_pii_entity_config()),
"regexesConfig" => list(guardrail_regex_config())
}
"""
@type guardrail_sensitive_information_policy_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
stop_model_customization_job_request() :: %{}
"""
@type stop_model_customization_job_request() :: %{}
@typedoc """
## Example:
metadata_configuration_for_reranking() :: %{
"selectionMode" => list(any()),
"selectiveModeConfiguration" => list()
}
"""
@type metadata_configuration_for_reranking() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_guardrail_version_response() :: %{
"guardrailId" => String.t() | atom(),
"version" => String.t() | atom()
}
"""
@type create_guardrail_version_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_custom_model_request() :: %{}
"""
@type delete_custom_model_request() :: %{}
@typedoc """
## Example:
validation_exception() :: %{
"message" => String.t() | atom()
}
"""
@type validation_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
required("resourceARN") => String.t() | atom()
}
"""
@type list_tags_for_resource_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_model_copy_job_response() :: %{
"jobArn" => String.t() | atom()
}
"""
@type create_model_copy_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_pii_entity_config() :: %{
"action" => list(any()),
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"type" => list(any())
}
"""
@type guardrail_pii_entity_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_automated_reasoning_policy_annotations_response() :: %{
"annotationSetHash" => String.t() | atom(),
"buildWorkflowId" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"updatedAt" => non_neg_integer()
}
"""
@type update_automated_reasoning_policy_annotations_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_check_impossible_finding() :: %{
"contradictingRules" => list(automated_reasoning_check_rule()),
"logicWarning" => automated_reasoning_check_logic_warning(),
"translation" => automated_reasoning_check_translation()
}
"""
@type automated_reasoning_check_impossible_finding() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_dataset() :: %{
"datasetLocation" => list(),
"name" => String.t() | atom()
}
"""
@type evaluation_dataset() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_automated_reasoning_policy_version_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("tags") => list(tag()),
required("lastUpdatedDefinitionHash") => String.t() | atom()
}
"""
@type create_automated_reasoning_policy_version_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_update_rule_annotation() :: %{
"expression" => String.t() | atom(),
"ruleId" => String.t() | atom()
}
"""
@type automated_reasoning_policy_update_rule_annotation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_workflow_source() :: %{
"policyDefinition" => automated_reasoning_policy_definition(),
"workflowContent" => list()
}
"""
@type automated_reasoning_policy_build_workflow_source() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_rule_mutation() :: %{
"rule" => automated_reasoning_policy_definition_rule()
}
"""
@type automated_reasoning_policy_add_rule_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_automated_reasoning_policy_test_cases_request() :: %{
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_automated_reasoning_policy_test_cases_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
throttling_exception() :: %{
"message" => String.t() | atom()
}
"""
@type throttling_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
custom_model_units() :: %{
"customModelUnitsPerModelCopy" => [integer()],
"customModelUnitsVersion" => String.t() | atom()
}
"""
@type custom_model_units() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_automated_reasoning_policy_build_workflow_response() :: %{
"buildWorkflowId" => String.t() | atom(),
"policyArn" => String.t() | atom()
}
"""
@type start_automated_reasoning_policy_build_workflow_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
get_model_customization_job_response() :: %{
"baseModelArn" => String.t() | atom(),
"clientRequestToken" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"customizationConfig" => list(),
"customizationType" => list(any()),
"endTime" => non_neg_integer(),
"failureMessage" => String.t() | atom(),
"hyperParameters" => map(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"outputDataConfig" => output_data_config(),
"outputModelArn" => String.t() | atom(),
"outputModelKmsKeyArn" => String.t() | atom(),
"outputModelName" => String.t() | atom(),
"roleArn" => String.t() | atom(),
"status" => list(any()),
"statusDetails" => status_details(),
"trainingDataConfig" => training_data_config(),
"trainingMetrics" => training_metrics(),
"validationDataConfig" => validation_data_config(),
"validationMetrics" => list(validator_metric()),
"vpcConfig" => vpc_config()
}
"""
@type get_model_customization_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_copy_job_response() :: %{
"creationTime" => non_neg_integer(),
"failureMessage" => String.t() | atom(),
"jobArn" => String.t() | atom(),
"sourceAccountId" => String.t() | atom(),
"sourceModelArn" => String.t() | atom(),
"sourceModelName" => String.t() | atom(),
"status" => list(any()),
"targetModelArn" => String.t() | atom(),
"targetModelKmsKeyArn" => String.t() | atom(),
"targetModelName" => String.t() | atom(),
"targetModelTags" => list(tag())
}
"""
@type get_model_copy_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_summary() :: %{
"createdAt" => non_neg_integer(),
"description" => String.t() | atom(),
"name" => String.t() | atom(),
"policyArn" => String.t() | atom(),
"policyId" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"version" => String.t() | atom()
}
"""
@type automated_reasoning_policy_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_marketplace_model_endpoint_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
required("endpointConfig") => list()
}
"""
@type update_marketplace_model_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_custom_models_response() :: %{
"modelSummaries" => list(custom_model_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_custom_models_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_test_case() :: %{
"confidenceThreshold" => float(),
"createdAt" => non_neg_integer(),
"expectedAggregatedFindingsResult" => list(any()),
"guardContent" => String.t() | atom(),
"queryContent" => String.t() | atom(),
"testCaseId" => String.t() | atom(),
"updatedAt" => non_neg_integer()
}
"""
@type automated_reasoning_policy_test_case() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_too_complex_finding() :: %{}
"""
@type automated_reasoning_check_too_complex_finding() :: %{}
@typedoc """
## Example:
list_prompt_routers_response() :: %{
"nextToken" => String.t() | atom(),
"promptRouterSummaries" => list(prompt_router_summary())
}
"""
@type list_prompt_routers_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_translation_ambiguous_finding() :: %{
"differenceScenarios" => list(automated_reasoning_check_scenario()),
"options" => list(automated_reasoning_check_translation_option())
}
"""
@type automated_reasoning_check_translation_ambiguous_finding() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
vector_search_bedrock_reranking_model_configuration() :: %{
"additionalModelRequestFields" => map(),
"modelArn" => String.t() | atom()
}
"""
@type vector_search_bedrock_reranking_model_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_logic_statement() :: %{
"logic" => String.t() | atom(),
"naturalLanguage" => String.t() | atom()
}
"""
@type automated_reasoning_logic_statement() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_topic_policy() :: %{
"tier" => guardrail_topics_tier(),
"topics" => list(guardrail_topic())
}
"""
@type guardrail_topic_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
output_data_config() :: %{
"s3Uri" => String.t() | atom()
}
"""
@type output_data_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_model_invocation_logging_configuration_response() :: %{
"loggingConfig" => logging_config()
}
"""
@type get_model_invocation_logging_configuration_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_automated_reasoning_policy_test_case_response() :: %{
"policyArn" => String.t() | atom(),
"testCaseId" => String.t() | atom()
}
"""
@type update_automated_reasoning_policy_test_case_response() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_policy_delete_type_value() :: %{
"value" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_type_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_step() :: %{
"context" => list(),
"messages" => list(automated_reasoning_policy_build_step_message()),
"priorElement" => list()
}
"""
@type automated_reasoning_policy_build_step() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_model_import_job_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("importedModelKmsKeyId") => String.t() | atom(),
optional("importedModelTags") => list(tag()),
optional("jobTags") => list(tag()),
optional("vpcConfig") => vpc_config(),
required("importedModelName") => String.t() | atom(),
required("jobName") => String.t() | atom(),
required("modelDataSource") => list(),
required("roleArn") => String.t() | atom()
}
"""
@type create_model_import_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_guardrail_version_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
optional("description") => String.t() | atom()
}
"""
@type create_guardrail_version_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_copy_jobs_request() :: %{
optional("creationTimeAfter") => non_neg_integer(),
optional("creationTimeBefore") => non_neg_integer(),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom(),
optional("sortBy") => list(any()),
optional("sortOrder") => list(any()),
optional("sourceAccountEquals") => String.t() | atom(),
optional("sourceModelArnEquals") => String.t() | atom(),
optional("statusEquals") => list(any()),
optional("targetModelNameContains") => String.t() | atom()
}
"""
@type list_model_copy_jobs_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
prompt_router_target_model() :: %{
"modelArn" => String.t() | atom()
}
"""
@type prompt_router_target_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_precomputed_retrieve_source_config() :: %{
"ragSourceIdentifier" => String.t() | atom()
}
"""
@type evaluation_precomputed_retrieve_source_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_guardrails_request() :: %{
optional("guardrailIdentifier") => String.t() | atom(),
optional("maxResults") => integer(),
optional("nextToken") => String.t() | atom()
}
"""
@type list_guardrails_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
term_details() :: %{
"legalTerm" => legal_term(),
"supportTerm" => support_term(),
"usageBasedPricingTerm" => pricing_term(),
"validityTerm" => validity_term()
}
"""
@type term_details() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validity_term() :: %{
"agreementDuration" => [String.t() | atom()]
}
"""
@type validity_term() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
dimensional_price_rate() :: %{
"description" => [String.t() | atom()],
"dimension" => [String.t() | atom()],
"price" => [String.t() | atom()],
"unit" => [String.t() | atom()]
}
"""
@type dimensional_price_rate() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
put_model_invocation_logging_configuration_response() :: %{}
"""
@type put_model_invocation_logging_configuration_response() :: %{}
@typedoc """
## Example:
guardrail_configuration() :: %{
"guardrailId" => [String.t() | atom()],
"guardrailVersion" => [String.t() | atom()]
}
"""
@type guardrail_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_rule_from_natural_language_annotation() :: %{
"naturalLanguage" => String.t() | atom()
}
"""
@type automated_reasoning_policy_add_rule_from_natural_language_annotation() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
automated_reasoning_policy_delete_rule_mutation() :: %{
"id" => String.t() | atom()
}
"""
@type automated_reasoning_policy_delete_rule_mutation() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
create_foundation_model_agreement_response() :: %{
"modelId" => String.t() | atom()
}
"""
@type create_foundation_model_agreement_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
validator() :: %{
"s3Uri" => String.t() | atom()
}
"""
@type validator() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
register_marketplace_model_endpoint_request() :: %{
required("modelSourceIdentifier") => String.t() | atom()
}
"""
@type register_marketplace_model_endpoint_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_regex() :: %{
"action" => list(any()),
"description" => [String.t() | atom()],
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"name" => [String.t() | atom()],
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"pattern" => [String.t() | atom()]
}
"""
@type guardrail_regex() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_test_result() :: %{
"aggregatedTestFindingsResult" => list(any()),
"policyArn" => String.t() | atom(),
"testCase" => automated_reasoning_policy_test_case(),
"testFindings" => list(list()),
"testRunResult" => list(any()),
"testRunStatus" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type automated_reasoning_policy_test_result() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
batch_delete_evaluation_job_request() :: %{
required("jobIdentifiers") => list(String.t() | atom())
}
"""
@type batch_delete_evaluation_job_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_automated_reasoning_policy_test_case_response() :: %{}
"""
@type delete_automated_reasoning_policy_test_case_response() :: %{}
@typedoc """
## Example:
create_evaluation_job_response() :: %{
"jobArn" => String.t() | atom()
}
"""
@type create_evaluation_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
update_guardrail_response() :: %{
"guardrailArn" => String.t() | atom(),
"guardrailId" => String.t() | atom(),
"updatedAt" => non_neg_integer(),
"version" => String.t() | atom()
}
"""
@type update_guardrail_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
model_invocation_job_summary() :: %{
"clientRequestToken" => String.t() | atom(),
"endTime" => non_neg_integer(),
"inputDataConfig" => list(),
"jobArn" => String.t() | atom(),
"jobExpirationTime" => non_neg_integer(),
"jobName" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"message" => String.t() | atom(),
"modelId" => String.t() | atom(),
"outputDataConfig" => list(),
"roleArn" => String.t() | atom(),
"status" => list(any()),
"submitTime" => non_neg_integer(),
"timeoutDurationInHours" => integer(),
"vpcConfig" => vpc_config()
}
"""
@type model_invocation_job_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
deregister_marketplace_model_endpoint_request() :: %{}
"""
@type deregister_marketplace_model_endpoint_request() :: %{}
@typedoc """
## Example:
request_metadata_base_filters() :: %{
"equals" => map(),
"notEquals" => map()
}
"""
@type request_metadata_base_filters() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_add_type_value() :: %{
"description" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type automated_reasoning_policy_add_type_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
register_marketplace_model_endpoint_response() :: %{
"marketplaceModelEndpoint" => marketplace_model_endpoint()
}
"""
@type register_marketplace_model_endpoint_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
kb_inference_config() :: %{
"textInferenceConfig" => text_inference_config()
}
"""
@type kb_inference_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_summary() :: %{
"applicationType" => list(any()),
"creationTime" => non_neg_integer(),
"customMetricsEvaluatorModelIdentifiers" => list(String.t() | atom()),
"evaluationTaskTypes" => list(list(any())()),
"evaluatorModelIdentifiers" => list(String.t() | atom()),
"inferenceConfigSummary" => evaluation_inference_config_summary(),
"jobArn" => String.t() | atom(),
"jobName" => String.t() | atom(),
"jobType" => list(any()),
"modelIdentifiers" => list(String.t() | atom()),
"ragIdentifiers" => list(String.t() | atom()),
"status" => list(any())
}
"""
@type evaluation_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
start_automated_reasoning_policy_build_workflow_request() :: %{
optional("clientRequestToken") => String.t() | atom(),
required("sourceContent") => automated_reasoning_policy_build_workflow_source()
}
"""
@type start_automated_reasoning_policy_build_workflow_request() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
create_custom_model_deployment_response() :: %{
"customModelDeploymentArn" => String.t() | atom()
}
"""
@type create_custom_model_deployment_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
training_data_config() :: %{
"invocationLogsConfig" => invocation_logs_config(),
"s3Uri" => String.t() | atom()
}
"""
@type training_data_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_check_invalid_finding() :: %{
"contradictingRules" => list(automated_reasoning_check_rule()),
"logicWarning" => automated_reasoning_check_logic_warning(),
"translation" => automated_reasoning_check_translation()
}
"""
@type automated_reasoning_check_invalid_finding() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_bedrock_model() :: %{
"inferenceParams" => String.t() | atom(),
"modelIdentifier" => String.t() | atom(),
"performanceConfig" => performance_configuration()
}
"""
@type evaluation_bedrock_model() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_model_invocation_logging_configuration_request() :: %{}
"""
@type delete_model_invocation_logging_configuration_request() :: %{}
@typedoc """
## Example:
automated_reasoning_policy_definition() :: %{
"rules" => list(automated_reasoning_policy_definition_rule()),
"types" => list(automated_reasoning_policy_definition_type()),
"variables" => list(automated_reasoning_policy_definition_variable()),
"version" => String.t() | atom()
}
"""
@type automated_reasoning_policy_definition() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_build_workflow_summary() :: %{
"buildWorkflowId" => String.t() | atom(),
"buildWorkflowType" => list(any()),
"createdAt" => non_neg_integer(),
"policyArn" => String.t() | atom(),
"status" => list(any()),
"updatedAt" => non_neg_integer()
}
"""
@type automated_reasoning_policy_build_workflow_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
evaluation_precomputed_retrieve_and_generate_source_config() :: %{
"ragSourceIdentifier" => String.t() | atom()
}
"""
@type evaluation_precomputed_retrieve_and_generate_source_config() :: %{
(String.t() | atom()) => any()
}
@typedoc """
## Example:
custom_model_summary() :: %{
"baseModelArn" => String.t() | atom(),
"baseModelName" => String.t() | atom(),
"creationTime" => non_neg_integer(),
"customizationType" => list(any()),
"modelArn" => String.t() | atom(),
"modelName" => String.t() | atom(),
"modelStatus" => list(any()),
"ownerAccountId" => String.t() | atom()
}
"""
@type custom_model_summary() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
automated_reasoning_policy_definition_type_value() :: %{
"description" => String.t() | atom(),
"value" => String.t() | atom()
}
"""
@type automated_reasoning_policy_definition_type_value() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_guardrail_request() :: %{
optional("guardrailVersion") => String.t() | atom()
}
"""
@type get_guardrail_request() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
get_foundation_model_response() :: %{
"modelDetails" => foundation_model_details()
}
"""
@type get_foundation_model_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
too_many_tags_exception() :: %{
"message" => String.t() | atom(),
"resourceName" => String.t() | atom()
}
"""
@type too_many_tags_exception() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_topic() :: %{
"definition" => String.t() | atom(),
"examples" => list(String.t() | atom()),
"inputAction" => list(any()),
"inputEnabled" => [boolean()],
"name" => String.t() | atom(),
"outputAction" => list(any()),
"outputEnabled" => [boolean()],
"type" => list(any())
}
"""
@type guardrail_topic() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
guardrail_contextual_grounding_policy() :: %{
"filters" => list(guardrail_contextual_grounding_filter())
}
"""
@type guardrail_contextual_grounding_policy() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
human_evaluation_config() :: %{
"customMetrics" => list(human_evaluation_custom_metric()),
"datasetMetricConfigs" => list(evaluation_dataset_metric_config()),
"humanWorkflowConfig" => human_workflow_config()
}
"""
@type human_evaluation_config() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
performance_configuration() :: %{
"latency" => list(any())
}
"""
@type performance_configuration() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
delete_marketplace_model_endpoint_request() :: %{}
"""
@type delete_marketplace_model_endpoint_request() :: %{}
@typedoc """
## Example:
delete_foundation_model_agreement_response() :: %{}
"""
@type delete_foundation_model_agreement_response() :: %{}
@typedoc """
## Example:
get_model_invocation_job_response() :: %{
"clientRequestToken" => String.t() | atom(),
"endTime" => non_neg_integer(),
"inputDataConfig" => list(),
"jobArn" => String.t() | atom(),
"jobExpirationTime" => non_neg_integer(),
"jobName" => String.t() | atom(),
"lastModifiedTime" => non_neg_integer(),
"message" => String.t() | atom(),
"modelId" => String.t() | atom(),
"outputDataConfig" => list(),
"roleArn" => String.t() | atom(),
"status" => list(any()),
"submitTime" => non_neg_integer(),
"timeoutDurationInHours" => integer(),
"vpcConfig" => vpc_config()
}
"""
@type get_model_invocation_job_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
list_model_import_jobs_response() :: %{
"modelImportJobSummaries" => list(model_import_job_summary()),
"nextToken" => String.t() | atom()
}
"""
@type list_model_import_jobs_response() :: %{(String.t() | atom()) => any()}
@typedoc """
## Example:
s3_data_source() :: %{
"s3Uri" => String.t() | atom()
}
"""
@type s3_data_source() :: %{(String.t() | atom()) => any()}
@type batch_delete_evaluation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type cancel_automated_reasoning_policy_build_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type create_automated_reasoning_policy_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_automated_reasoning_policy_test_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_automated_reasoning_policy_version_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_custom_model_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_custom_model_deployment_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type create_evaluation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_foundation_model_agreement_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_guardrail_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_guardrail_version_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_inference_profile_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_marketplace_model_endpoint_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_model_copy_job_errors() ::
too_many_tags_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type create_model_customization_job_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_model_import_job_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_model_invocation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_prompt_router_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type create_provisioned_model_throughput_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type delete_automated_reasoning_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_automated_reasoning_policy_build_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_automated_reasoning_policy_test_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
| resource_in_use_exception()
@type delete_custom_model_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_custom_model_deployment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_foundation_model_agreement_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_guardrail_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_imported_model_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_inference_profile_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type delete_marketplace_model_endpoint_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_model_invocation_logging_configuration_errors() ::
throttling_exception() | access_denied_exception() | internal_server_exception()
@type delete_prompt_router_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type delete_provisioned_model_throughput_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type deregister_marketplace_model_endpoint_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_unavailable_exception()
| resource_not_found_exception()
@type export_automated_reasoning_policy_version_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_annotations_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_build_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_build_workflow_result_assets_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_next_scenario_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_test_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_automated_reasoning_policy_test_result_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_custom_model_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_custom_model_deployment_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_evaluation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_foundation_model_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_foundation_model_availability_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_guardrail_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_imported_model_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_inference_profile_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_marketplace_model_endpoint_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_model_copy_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_model_customization_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_model_import_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_model_invocation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_model_invocation_logging_configuration_errors() ::
throttling_exception() | access_denied_exception() | internal_server_exception()
@type get_prompt_router_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_provisioned_model_throughput_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type get_use_case_for_model_access_errors() ::
throttling_exception()
| validation_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_automated_reasoning_policies_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_automated_reasoning_policy_build_workflows_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_automated_reasoning_policy_test_cases_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_automated_reasoning_policy_test_results_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
@type list_custom_model_deployments_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_custom_models_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_evaluation_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_foundation_model_agreement_offers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_foundation_models_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_guardrails_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_imported_models_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_inference_profiles_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_marketplace_model_endpoints_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_model_copy_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type list_model_customization_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_model_import_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_model_invocation_jobs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_prompt_routers_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_provisioned_model_throughputs_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type list_tags_for_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type put_model_invocation_logging_configuration_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type put_use_case_for_model_access_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
@type register_marketplace_model_endpoint_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_unavailable_exception()
| resource_not_found_exception()
@type start_automated_reasoning_policy_build_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
| resource_in_use_exception()
@type start_automated_reasoning_policy_test_workflow_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| resource_in_use_exception()
@type stop_evaluation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type stop_model_customization_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type stop_model_invocation_job_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type tag_resource_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type untag_resource_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
@type update_automated_reasoning_policy_errors() ::
too_many_tags_exception()
| throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_automated_reasoning_policy_annotations_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_automated_reasoning_policy_test_case_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
| conflict_exception()
| resource_in_use_exception()
@type update_guardrail_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_marketplace_model_endpoint_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| service_quota_exceeded_exception()
| resource_not_found_exception()
| conflict_exception()
@type update_provisioned_model_throughput_errors() ::
throttling_exception()
| validation_exception()
| access_denied_exception()
| internal_server_exception()
| resource_not_found_exception()
def metadata do
%{
api_version: "2023-04-20",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "bedrock",
global?: false,
hostname: nil,
protocol: "rest-json",
service_id: "Bedrock",
signature_version: "v4",
signing_name: "bedrock",
target_prefix: nil
}
end
@doc """
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.
"""
@spec batch_delete_evaluation_job(map(), batch_delete_evaluation_job_request(), list()) ::
{:ok, batch_delete_evaluation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, batch_delete_evaluation_job_errors()}
def batch_delete_evaluation_job(%Client{} = client, input, options \\ []) do
url_path = "/evaluation-jobs/batch-delete"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Cancels a running Automated Reasoning policy build workflow.
This stops the policy generation process and prevents further processing of the
source documents.
"""
@spec cancel_automated_reasoning_policy_build_workflow(
map(),
String.t() | atom(),
String.t() | atom(),
cancel_automated_reasoning_policy_build_workflow_request(),
list()
) ::
{:ok, cancel_automated_reasoning_policy_build_workflow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, cancel_automated_reasoning_policy_build_workflow_errors()}
def cancel_automated_reasoning_policy_build_workflow(
%Client{} = client,
build_workflow_id,
policy_arn,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/cancel"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
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.
"""
@spec create_automated_reasoning_policy(
map(),
create_automated_reasoning_policy_request(),
list()
) ::
{:ok, create_automated_reasoning_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_automated_reasoning_policy_errors()}
def create_automated_reasoning_policy(%Client{} = client, input, options \\ []) do
url_path = "/automated-reasoning-policies"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_automated_reasoning_policy_test_case(
map(),
String.t() | atom(),
create_automated_reasoning_policy_test_case_request(),
list()
) ::
{:ok, create_automated_reasoning_policy_test_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_automated_reasoning_policy_test_case_errors()}
def create_automated_reasoning_policy_test_case(
%Client{} = client,
policy_arn,
input,
options \\ []
) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/test-cases"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec create_automated_reasoning_policy_version(
map(),
String.t() | atom(),
create_automated_reasoning_policy_version_request(),
list()
) ::
{:ok, create_automated_reasoning_policy_version_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_automated_reasoning_policy_version_errors()}
def create_automated_reasoning_policy_version(
%Client{} = client,
policy_arn,
input,
options \\ []
) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/versions"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a new custom model in Amazon Bedrock.
After the model is active, you can use it for inference.
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](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html).
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModel.html) *
[ListCustomModels](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModels.html)
*
[DeleteCustomModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModel.html)
"""
@spec create_custom_model(map(), create_custom_model_request(), list()) ::
{:ok, create_custom_model_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_custom_model_errors()}
def create_custom_model(%Client{} = client, input, options \\ []) do
url_path = "/custom-models/create-custom-model"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html).
The following actions are related to the `CreateCustomModelDeployment`
operation:
*
[GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html) *
[ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html)
*
[DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html)
"""
@spec create_custom_model_deployment(map(), create_custom_model_deployment_request(), list()) ::
{:ok, create_custom_model_deployment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_custom_model_deployment_errors()}
def create_custom_model_deployment(%Client{} = client, input, options \\ []) do
url_path = "/model-customization/custom-model-deployments"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Creates an evaluation job.
"""
@spec create_evaluation_job(map(), create_evaluation_job_request(), list()) ::
{:ok, create_evaluation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_evaluation_job_errors()}
def create_evaluation_job(%Client{} = client, input, options \\ []) do
url_path = "/evaluation-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Request a model access agreement for the specified model.
"""
@spec create_foundation_model_agreement(
map(),
create_foundation_model_agreement_request(),
list()
) ::
{:ok, create_foundation_model_agreement_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_foundation_model_agreement_errors()}
def create_foundation_model_agreement(%Client{} = client, input, options \\ []) do
url_path = "/create-foundation-model-agreement"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails.html)
in the *Amazon Bedrock User Guide*.
"""
@spec create_guardrail(map(), create_guardrail_request(), list()) ::
{:ok, create_guardrail_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_guardrail_errors()}
def create_guardrail(%Client{} = client, input, options \\ []) do
url_path = "/guardrails"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
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.
"""
@spec create_guardrail_version(
map(),
String.t() | atom(),
create_guardrail_version_request(),
list()
) ::
{:ok, create_guardrail_version_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_guardrail_version_errors()}
def create_guardrail_version(%Client{} = client, guardrail_identifier, input, options \\ []) do
url_path = "/guardrails/#{AWS.Util.encode_uri(guardrail_identifier)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html).
in the Amazon Bedrock User Guide.
"""
@spec create_inference_profile(map(), create_inference_profile_request(), list()) ::
{:ok, create_inference_profile_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_inference_profile_errors()}
def create_inference_profile(%Client{} = client, input, options \\ []) do
url_path = "/inference-profiles"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
Creates an endpoint for a model from Amazon Bedrock Marketplace.
The endpoint is hosted by Amazon SageMaker.
"""
@spec create_marketplace_model_endpoint(
map(),
create_marketplace_model_endpoint_request(),
list()
) ::
{:ok, create_marketplace_model_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_marketplace_model_endpoint_errors()}
def create_marketplace_model_endpoint(%Client{} = client, input, options \\ []) do
url_path = "/marketplace-model/endpoints"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec create_model_copy_job(map(), create_model_copy_job_request(), list()) ::
{:ok, create_model_copy_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_model_copy_job_errors()}
def create_model_copy_job(%Client{} = client, input, options \\ []) do
url_path = "/model-copy-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-prepare.html).
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](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec create_model_customization_job(map(), create_model_customization_job_request(), list()) ::
{:ok, create_model_customization_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_model_customization_job_errors()}
def create_model_customization_job(%Client{} = client, input, options \\ []) do
url_path = "/model-customization-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html)
"""
@spec create_model_import_job(map(), create_model_import_job_request(), list()) ::
{:ok, create_model_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_model_import_job_errors()}
def create_model_import_job(%Client{} = client, input, options \\ []) do
url_path = "/model-import-jobs"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
Creates a batch inference job to invoke a model on multiple prompts.
Format your data according to [Format your inference data](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-data)
and upload it to an Amazon S3 bucket. For more information, see [Process multiple prompts with batch
inference](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference.html).
The response returns a `jobArn` that you can use to stop or get details about
the job.
"""
@spec create_model_invocation_job(map(), create_model_invocation_job_request(), list()) ::
{:ok, create_model_invocation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_model_invocation_job_errors()}
def create_model_invocation_job(%Client{} = client, input, options \\ []) do
url_path = "/model-invocation-job"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Creates a prompt router that manages the routing of requests between multiple
foundation models based on the routing criteria.
"""
@spec create_prompt_router(map(), create_prompt_router_request(), list()) ::
{:ok, create_prompt_router_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_prompt_router_errors()}
def create_prompt_router(%Client{} = client, input, options \\ []) do
url_path = "/prompt-routers"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](http://aws.amazon.com/bedrock/pricing/). For more information, see
[Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec create_provisioned_model_throughput(
map(),
create_provisioned_model_throughput_request(),
list()
) ::
{:ok, create_provisioned_model_throughput_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, create_provisioned_model_throughput_errors()}
def create_provisioned_model_throughput(%Client{} = client, input, options \\ []) do
url_path = "/provisioned-model-throughput"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
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.
"""
@spec delete_automated_reasoning_policy(
map(),
String.t() | atom(),
delete_automated_reasoning_policy_request(),
list()
) ::
{:ok, delete_automated_reasoning_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_automated_reasoning_policy_errors()}
def delete_automated_reasoning_policy(%Client{} = client, policy_arn, input, options \\ []) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Deletes an Automated Reasoning policy build workflow and its associated
artifacts.
This permanently removes the workflow history and any generated assets.
"""
@spec delete_automated_reasoning_policy_build_workflow(
map(),
String.t() | atom(),
String.t() | atom(),
delete_automated_reasoning_policy_build_workflow_request(),
list()
) ::
{:ok, delete_automated_reasoning_policy_build_workflow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_automated_reasoning_policy_build_workflow_errors()}
def delete_automated_reasoning_policy_build_workflow(
%Client{} = client,
build_workflow_id,
policy_arn,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"lastUpdatedAt", "updatedAt"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Deletes an Automated Reasoning policy test.
This operation is idempotent; if you delete a test more than once, each call
succeeds.
"""
@spec delete_automated_reasoning_policy_test_case(
map(),
String.t() | atom(),
String.t() | atom(),
delete_automated_reasoning_policy_test_case_request(),
list()
) ::
{:ok, delete_automated_reasoning_policy_test_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_automated_reasoning_policy_test_case_errors()}
def delete_automated_reasoning_policy_test_case(
%Client{} = client,
policy_arn,
test_case_id,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/test-cases/#{AWS.Util.encode_uri(test_case_id)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"lastUpdatedAt", "updatedAt"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Deletes a custom model that you created earlier.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec delete_custom_model(map(), String.t() | atom(), delete_custom_model_request(), list()) ::
{:ok, delete_custom_model_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_custom_model_errors()}
def delete_custom_model(%Client{} = client, model_identifier, input, options \\ []) do
url_path = "/custom-models/#{AWS.Util.encode_uri(model_identifier)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html) *
[GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html)
*
[ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html)
"""
@spec delete_custom_model_deployment(
map(),
String.t() | atom(),
delete_custom_model_deployment_request(),
list()
) ::
{:ok, delete_custom_model_deployment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_custom_model_deployment_errors()}
def delete_custom_model_deployment(
%Client{} = client,
custom_model_deployment_identifier,
input,
options \\ []
) do
url_path =
"/model-customization/custom-model-deployments/#{AWS.Util.encode_uri(custom_model_deployment_identifier)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete the model access agreement for the specified model.
"""
@spec delete_foundation_model_agreement(
map(),
delete_foundation_model_agreement_request(),
list()
) ::
{:ok, delete_foundation_model_agreement_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_foundation_model_agreement_errors()}
def delete_foundation_model_agreement(%Client{} = client, input, options \\ []) do
url_path = "/delete-foundation-model-agreement"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
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.
"""
@spec delete_guardrail(map(), String.t() | atom(), delete_guardrail_request(), list()) ::
{:ok, delete_guardrail_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_guardrail_errors()}
def delete_guardrail(%Client{} = client, guardrail_identifier, input, options \\ []) do
url_path = "/guardrails/#{AWS.Util.encode_uri(guardrail_identifier)}"
headers = []
custom_headers = []
{query_params, input} =
[
{"guardrailVersion", "guardrailVersion"}
]
|> Request.build_params(input)
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Deletes a custom model that you imported earlier.
For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec delete_imported_model(map(), String.t() | atom(), delete_imported_model_request(), list()) ::
{:ok, delete_imported_model_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_imported_model_errors()}
def delete_imported_model(%Client{} = client, model_identifier, input, options \\ []) do
url_path = "/imported-models/#{AWS.Util.encode_uri(model_identifier)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an application inference profile.
For more information, see [Increase throughput and resilience with cross-region inference in Amazon
Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html).
in the Amazon Bedrock User Guide.
"""
@spec delete_inference_profile(
map(),
String.t() | atom(),
delete_inference_profile_request(),
list()
) ::
{:ok, delete_inference_profile_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_inference_profile_errors()}
def delete_inference_profile(
%Client{} = client,
inference_profile_identifier,
input,
options \\ []
) do
url_path = "/inference-profiles/#{AWS.Util.encode_uri(inference_profile_identifier)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes an endpoint for a model from Amazon Bedrock Marketplace.
"""
@spec delete_marketplace_model_endpoint(
map(),
String.t() | atom(),
delete_marketplace_model_endpoint_request(),
list()
) ::
{:ok, delete_marketplace_model_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_marketplace_model_endpoint_errors()}
def delete_marketplace_model_endpoint(%Client{} = client, endpoint_arn, input, options \\ []) do
url_path = "/marketplace-model/endpoints/#{AWS.Util.encode_uri(endpoint_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Delete the invocation logging.
"""
@spec delete_model_invocation_logging_configuration(
map(),
delete_model_invocation_logging_configuration_request(),
list()
) ::
{:ok, delete_model_invocation_logging_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_model_invocation_logging_configuration_errors()}
def delete_model_invocation_logging_configuration(%Client{} = client, input, options \\ []) do
url_path = "/logging/modelinvocations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a specified prompt router.
This action cannot be undone.
"""
@spec delete_prompt_router(map(), String.t() | atom(), delete_prompt_router_request(), list()) ::
{:ok, delete_prompt_router_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_prompt_router_errors()}
def delete_prompt_router(%Client{} = client, prompt_router_arn, input, options \\ []) do
url_path = "/prompt-routers/#{AWS.Util.encode_uri(prompt_router_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Deletes a Provisioned Throughput.
You can't delete a Provisioned Throughput before the commitment term is over.
For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec delete_provisioned_model_throughput(
map(),
String.t() | atom(),
delete_provisioned_model_throughput_request(),
list()
) ::
{:ok, delete_provisioned_model_throughput_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, delete_provisioned_model_throughput_errors()}
def delete_provisioned_model_throughput(
%Client{} = client,
provisioned_model_id,
input,
options \\ []
) do
url_path = "/provisioned-model-throughput/#{AWS.Util.encode_uri(provisioned_model_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec deregister_marketplace_model_endpoint(
map(),
String.t() | atom(),
deregister_marketplace_model_endpoint_request(),
list()
) ::
{:ok, deregister_marketplace_model_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, deregister_marketplace_model_endpoint_errors()}
def deregister_marketplace_model_endpoint(
%Client{} = client,
endpoint_arn,
input,
options \\ []
) do
url_path = "/marketplace-model/endpoints/#{AWS.Util.encode_uri(endpoint_arn)}/registration"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:delete,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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.
"""
@spec export_automated_reasoning_policy_version(map(), String.t() | atom(), list()) ::
{:ok, export_automated_reasoning_policy_version_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, export_automated_reasoning_policy_version_errors()}
def export_automated_reasoning_policy_version(%Client{} = client, policy_arn, options \\ []) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/export"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves details about an Automated Reasoning policy or policy version.
Returns information including the policy definition, metadata, and timestamps.
"""
@spec get_automated_reasoning_policy(map(), String.t() | atom(), list()) ::
{:ok, get_automated_reasoning_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_errors()}
def get_automated_reasoning_policy(%Client{} = client, policy_arn, options \\ []) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec get_automated_reasoning_policy_annotations(
map(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_automated_reasoning_policy_annotations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_annotations_errors()}
def get_automated_reasoning_policy_annotations(
%Client{} = client,
build_workflow_id,
policy_arn,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/annotations"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves detailed information about an Automated Reasoning policy build
workflow, including its status, configuration, and metadata.
"""
@spec get_automated_reasoning_policy_build_workflow(
map(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_automated_reasoning_policy_build_workflow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_build_workflow_errors()}
def get_automated_reasoning_policy_build_workflow(
%Client{} = client,
build_workflow_id,
policy_arn,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the resulting assets from a completed Automated Reasoning policy build
workflow, including build logs, quality reports, and generated policy artifacts.
"""
@spec get_automated_reasoning_policy_build_workflow_result_assets(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_automated_reasoning_policy_build_workflow_result_assets_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_build_workflow_result_assets_errors()}
def get_automated_reasoning_policy_build_workflow_result_assets(
%Client{} = client,
build_workflow_id,
policy_arn,
asset_type,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/result-assets"
headers = []
query_params = []
query_params =
if !is_nil(asset_type) do
[{"assetType", asset_type} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the next test scenario for validating an Automated Reasoning policy.
This is used during the interactive policy refinement process to test policy
behavior.
"""
@spec get_automated_reasoning_policy_next_scenario(
map(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_automated_reasoning_policy_next_scenario_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_next_scenario_errors()}
def get_automated_reasoning_policy_next_scenario(
%Client{} = client,
build_workflow_id,
policy_arn,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/scenarios"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves details about a specific Automated Reasoning policy test.
"""
@spec get_automated_reasoning_policy_test_case(
map(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_automated_reasoning_policy_test_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_test_case_errors()}
def get_automated_reasoning_policy_test_case(
%Client{} = client,
policy_arn,
test_case_id,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/test-cases/#{AWS.Util.encode_uri(test_case_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the test result for a specific Automated Reasoning policy test.
Returns detailed validation findings and execution status.
"""
@spec get_automated_reasoning_policy_test_result(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom(),
list()
) ::
{:ok, get_automated_reasoning_policy_test_result_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_automated_reasoning_policy_test_result_errors()}
def get_automated_reasoning_policy_test_result(
%Client{} = client,
build_workflow_id,
policy_arn,
test_case_id,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/test-cases/#{AWS.Util.encode_uri(test_case_id)}/test-results"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get the properties associated with a Amazon Bedrock custom model that you have
created.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec get_custom_model(map(), String.t() | atom(), list()) ::
{:ok, get_custom_model_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_custom_model_errors()}
def get_custom_model(%Client{} = client, model_identifier, options \\ []) do
url_path = "/custom-models/#{AWS.Util.encode_uri(model_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html) *
[ListCustomModelDeployments](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_ListCustomModelDeployments.html)
*
[DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html)
"""
@spec get_custom_model_deployment(map(), String.t() | atom(), list()) ::
{:ok, get_custom_model_deployment_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_custom_model_deployment_errors()}
def get_custom_model_deployment(
%Client{} = client,
custom_model_deployment_identifier,
options \\ []
) do
url_path =
"/model-customization/custom-model-deployments/#{AWS.Util.encode_uri(custom_model_deployment_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets information about an evaluation job, such as the status of the job.
"""
@spec get_evaluation_job(map(), String.t() | atom(), list()) ::
{:ok, get_evaluation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_evaluation_job_errors()}
def get_evaluation_job(%Client{} = client, job_identifier, options \\ []) do
url_path = "/evaluation-jobs/#{AWS.Util.encode_uri(job_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get details about a Amazon Bedrock foundation model.
"""
@spec get_foundation_model(map(), String.t() | atom(), list()) ::
{:ok, get_foundation_model_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_foundation_model_errors()}
def get_foundation_model(%Client{} = client, model_identifier, options \\ []) do
url_path = "/foundation-models/#{AWS.Util.encode_uri(model_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get information about the Foundation model availability.
"""
@spec get_foundation_model_availability(map(), String.t() | atom(), list()) ::
{:ok, get_foundation_model_availability_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_foundation_model_availability_errors()}
def get_foundation_model_availability(%Client{} = client, model_id, options \\ []) do
url_path = "/foundation-model-availability/#{AWS.Util.encode_uri(model_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a guardrail.
If you don't specify a version, the response returns details for the `DRAFT`
version.
"""
@spec get_guardrail(map(), String.t() | atom(), String.t() | atom() | nil, list()) ::
{:ok, get_guardrail_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_guardrail_errors()}
def get_guardrail(
%Client{} = client,
guardrail_identifier,
guardrail_version \\ nil,
options \\ []
) do
url_path = "/guardrails/#{AWS.Util.encode_uri(guardrail_identifier)}"
headers = []
query_params = []
query_params =
if !is_nil(guardrail_version) do
[{"guardrailVersion", guardrail_version} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets properties associated with a customized model you imported.
"""
@spec get_imported_model(map(), String.t() | atom(), list()) ::
{:ok, get_imported_model_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_imported_model_errors()}
def get_imported_model(%Client{} = client, model_identifier, options \\ []) do
url_path = "/imported-models/#{AWS.Util.encode_uri(model_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets information about an inference profile.
For more information, see [Increase throughput and resilience with cross-region inference in Amazon
Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html).
in the Amazon Bedrock User Guide.
"""
@spec get_inference_profile(map(), String.t() | atom(), list()) ::
{:ok, get_inference_profile_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_inference_profile_errors()}
def get_inference_profile(%Client{} = client, inference_profile_identifier, options \\ []) do
url_path = "/inference-profiles/#{AWS.Util.encode_uri(inference_profile_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves details about a specific endpoint for a model from Amazon Bedrock
Marketplace.
"""
@spec get_marketplace_model_endpoint(map(), String.t() | atom(), list()) ::
{:ok, get_marketplace_model_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_marketplace_model_endpoint_errors()}
def get_marketplace_model_endpoint(%Client{} = client, endpoint_arn, options \\ []) do
url_path = "/marketplace-model/endpoints/#{AWS.Util.encode_uri(endpoint_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves information about a model copy job.
For more information, see [Copy models to be used in other regions](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec get_model_copy_job(map(), String.t() | atom(), list()) ::
{:ok, get_model_copy_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_model_copy_job_errors()}
def get_model_copy_job(%Client{} = client, job_arn, options \\ []) do
url_path = "/model-copy-jobs/#{AWS.Util.encode_uri(job_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the properties associated with a model-customization job, including
the status of the job.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec get_model_customization_job(map(), String.t() | atom(), list()) ::
{:ok, get_model_customization_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_model_customization_job_errors()}
def get_model_customization_job(%Client{} = client, job_identifier, options \\ []) do
url_path = "/model-customization-jobs/#{AWS.Util.encode_uri(job_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves the properties associated with import model job, including the status
of the job.
For more information, see [Import a customized model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec get_model_import_job(map(), String.t() | atom(), list()) ::
{:ok, get_model_import_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_model_import_job_errors()}
def get_model_import_job(%Client{} = client, job_identifier, options \\ []) do
url_path = "/model-import-jobs/#{AWS.Util.encode_uri(job_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Gets details about a batch inference job.
For more information, see [Monitor batch inference jobs](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-monitor)
"""
@spec get_model_invocation_job(map(), String.t() | atom(), list()) ::
{:ok, get_model_invocation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_model_invocation_job_errors()}
def get_model_invocation_job(%Client{} = client, job_identifier, options \\ []) do
url_path = "/model-invocation-job/#{AWS.Util.encode_uri(job_identifier)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get the current configuration values for model invocation logging.
"""
@spec get_model_invocation_logging_configuration(map(), list()) ::
{:ok, get_model_invocation_logging_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_model_invocation_logging_configuration_errors()}
def get_model_invocation_logging_configuration(%Client{} = client, options \\ []) do
url_path = "/logging/modelinvocations"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves details about a prompt router.
"""
@spec get_prompt_router(map(), String.t() | atom(), list()) ::
{:ok, get_prompt_router_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_prompt_router_errors()}
def get_prompt_router(%Client{} = client, prompt_router_arn, options \\ []) do
url_path = "/prompt-routers/#{AWS.Util.encode_uri(prompt_router_arn)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns details for a Provisioned Throughput.
For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec get_provisioned_model_throughput(map(), String.t() | atom(), list()) ::
{:ok, get_provisioned_model_throughput_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_provisioned_model_throughput_errors()}
def get_provisioned_model_throughput(%Client{} = client, provisioned_model_id, options \\ []) do
url_path = "/provisioned-model-throughput/#{AWS.Util.encode_uri(provisioned_model_id)}"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get usecase for model access.
"""
@spec get_use_case_for_model_access(map(), list()) ::
{:ok, get_use_case_for_model_access_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, get_use_case_for_model_access_errors()}
def get_use_case_for_model_access(%Client{} = client, options \\ []) do
url_path = "/use-case-for-model-access"
headers = []
query_params = []
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all Automated Reasoning policies in your account, with optional filtering
by policy ARN.
This helps you manage and discover existing policies.
"""
@spec list_automated_reasoning_policies(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_automated_reasoning_policies_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_automated_reasoning_policies_errors()}
def list_automated_reasoning_policies(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
policy_arn \\ nil,
options \\ []
) do
url_path = "/automated-reasoning-policies"
headers = []
query_params = []
query_params =
if !is_nil(policy_arn) do
[{"policyArn", policy_arn} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all build workflows for an Automated Reasoning policy, showing the history
of policy creation and modification attempts.
"""
@spec list_automated_reasoning_policy_build_workflows(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_automated_reasoning_policy_build_workflows_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_automated_reasoning_policy_build_workflows_errors()}
def list_automated_reasoning_policy_build_workflows(
%Client{} = client,
policy_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists tests for an Automated Reasoning policy.
We recommend using pagination to ensure that the operation returns quickly and
successfully.
"""
@spec list_automated_reasoning_policy_test_cases(
map(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_automated_reasoning_policy_test_cases_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_automated_reasoning_policy_test_cases_errors()}
def list_automated_reasoning_policy_test_cases(
%Client{} = client,
policy_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/test-cases"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists test results for an Automated Reasoning policy, showing how the policy
performed against various test scenarios and validation checks.
"""
@spec list_automated_reasoning_policy_test_results(
map(),
String.t() | atom(),
String.t() | atom(),
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_automated_reasoning_policy_test_results_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_automated_reasoning_policy_test_results_errors()}
def list_automated_reasoning_policy_test_results(
%Client{} = client,
build_workflow_id,
policy_arn,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/test-results"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists custom model deployments in your account.
You can filter the results by creation time, name, status, and associated model.
Use this operation to manage and monitor your custom model deployments.
We recommend using pagination to ensure that the operation returns quickly and
successfully.
The following actions are related to the `ListCustomModelDeployments` operation:
*
[CreateCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateCustomModelDeployment.html) *
[GetCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetCustomModelDeployment.html)
*
[DeleteCustomModelDeployment](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_DeleteCustomModelDeployment.html)
"""
@spec list_custom_model_deployments(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_custom_model_deployments_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_custom_model_deployments_errors()}
def list_custom_model_deployments(
%Client{} = client,
created_after \\ nil,
created_before \\ nil,
max_results \\ nil,
model_arn_equals \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
status_equals \\ nil,
options \\ []
) do
url_path = "/model-customization/custom-model-deployments"
headers = []
query_params = []
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(model_arn_equals) do
[{"modelArnEquals", model_arn_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(created_before) do
[{"createdBefore", created_before} | query_params]
else
query_params
end
query_params =
if !is_nil(created_after) do
[{"createdAfter", created_after} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Returns a list of the custom models that you have created with the
`CreateModelCustomizationJob` operation.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_custom_models(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_custom_models_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_custom_models_errors()}
def list_custom_models(
%Client{} = client,
base_model_arn_equals \\ nil,
creation_time_after \\ nil,
creation_time_before \\ nil,
foundation_model_arn_equals \\ nil,
is_owned \\ nil,
max_results \\ nil,
model_status \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
options \\ []
) do
url_path = "/custom-models"
headers = []
query_params = []
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(model_status) do
[{"modelStatus", model_status} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(is_owned) do
[{"isOwned", is_owned} | query_params]
else
query_params
end
query_params =
if !is_nil(foundation_model_arn_equals) do
[{"foundationModelArnEquals", foundation_model_arn_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
query_params =
if !is_nil(base_model_arn_equals) do
[{"baseModelArnEquals", base_model_arn_equals} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all existing evaluation jobs.
"""
@spec list_evaluation_jobs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_evaluation_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_evaluation_jobs_errors()}
def list_evaluation_jobs(
%Client{} = client,
application_type_equals \\ nil,
creation_time_after \\ nil,
creation_time_before \\ nil,
max_results \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
status_equals \\ nil,
options \\ []
) do
url_path = "/evaluation-jobs"
headers = []
query_params = []
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
query_params =
if !is_nil(application_type_equals) do
[{"applicationTypeEquals", application_type_equals} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Get the offers associated with the specified model.
"""
@spec list_foundation_model_agreement_offers(
map(),
String.t() | atom(),
String.t() | atom() | nil,
list()
) ::
{:ok, list_foundation_model_agreement_offers_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_foundation_model_agreement_offers_errors()}
def list_foundation_model_agreement_offers(
%Client{} = client,
model_id,
offer_type \\ nil,
options \\ []
) do
url_path = "/list-foundation-model-agreement-offers/#{AWS.Util.encode_uri(model_id)}"
headers = []
query_params = []
query_params =
if !is_nil(offer_type) do
[{"offerType", offer_type} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists Amazon Bedrock foundation models that you can use.
You can filter the results with the request parameters. For more information,
see [Foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/foundation-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_foundation_models(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_foundation_models_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_foundation_models_errors()}
def list_foundation_models(
%Client{} = client,
by_customization_type \\ nil,
by_inference_type \\ nil,
by_output_modality \\ nil,
by_provider \\ nil,
options \\ []
) do
url_path = "/foundation-models"
headers = []
query_params = []
query_params =
if !is_nil(by_provider) do
[{"byProvider", by_provider} | query_params]
else
query_params
end
query_params =
if !is_nil(by_output_modality) do
[{"byOutputModality", by_output_modality} | query_params]
else
query_params
end
query_params =
if !is_nil(by_inference_type) do
[{"byInferenceType", by_inference_type} | query_params]
else
query_params
end
query_params =
if !is_nil(by_customization_type) do
[{"byCustomizationType", by_customization_type} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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.
"""
@spec list_guardrails(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_guardrails_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_guardrails_errors()}
def list_guardrails(
%Client{} = client,
guardrail_identifier \\ nil,
max_results \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/guardrails"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(guardrail_identifier) do
[{"guardrailIdentifier", guardrail_identifier} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_imported_models(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_imported_models_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_imported_models_errors()}
def list_imported_models(
%Client{} = client,
creation_time_after \\ nil,
creation_time_before \\ nil,
max_results \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
options \\ []
) do
url_path = "/imported-models"
headers = []
query_params = []
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference.html).
in the Amazon Bedrock User Guide.
"""
@spec list_inference_profiles(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_inference_profiles_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_inference_profiles_errors()}
def list_inference_profiles(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
type_equals \\ nil,
options \\ []
) do
url_path = "/inference-profiles"
headers = []
query_params = []
query_params =
if !is_nil(type_equals) do
[{"type", type_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the endpoints for models from Amazon Bedrock Marketplace in your Amazon
Web Services account.
"""
@spec list_marketplace_model_endpoints(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_marketplace_model_endpoints_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_marketplace_model_endpoints_errors()}
def list_marketplace_model_endpoints(
%Client{} = client,
max_results \\ nil,
model_source_equals \\ nil,
next_token \\ nil,
options \\ []
) do
url_path = "/marketplace-model/endpoints"
headers = []
query_params = []
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(model_source_equals) do
[{"modelSourceIdentifier", model_source_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/copy-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_model_copy_jobs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_model_copy_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_model_copy_jobs_errors()}
def list_model_copy_jobs(
%Client{} = client,
creation_time_after \\ nil,
creation_time_before \\ nil,
max_results \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
source_account_equals \\ nil,
source_model_arn_equals \\ nil,
status_equals \\ nil,
target_model_name_contains \\ nil,
options \\ []
) do
url_path = "/model-copy-jobs"
headers = []
query_params = []
query_params =
if !is_nil(target_model_name_contains) do
[{"outputModelNameContains", target_model_name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(source_model_arn_equals) do
[{"sourceModelArnEquals", source_model_arn_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(source_account_equals) do
[{"sourceAccountEquals", source_account_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_model_customization_jobs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_model_customization_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_model_customization_jobs_errors()}
def list_model_customization_jobs(
%Client{} = client,
creation_time_after \\ nil,
creation_time_before \\ nil,
max_results \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
status_equals \\ nil,
options \\ []
) do
url_path = "/model-customization-jobs"
headers = []
query_params = []
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_model_import_jobs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_model_import_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_model_import_jobs_errors()}
def list_model_import_jobs(
%Client{} = client,
creation_time_after \\ nil,
creation_time_before \\ nil,
max_results \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
status_equals \\ nil,
options \\ []
) do
url_path = "/model-import-jobs"
headers = []
query_params = []
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists all batch inference jobs in the account.
For more information, see [View details about a batch inference job](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-view.html).
"""
@spec list_model_invocation_jobs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_model_invocation_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_model_invocation_jobs_errors()}
def list_model_invocation_jobs(
%Client{} = client,
max_results \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
status_equals \\ nil,
submit_time_after \\ nil,
submit_time_before \\ nil,
options \\ []
) do
url_path = "/model-invocation-jobs"
headers = []
query_params = []
query_params =
if !is_nil(submit_time_before) do
[{"submitTimeBefore", submit_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(submit_time_after) do
[{"submitTimeAfter", submit_time_after} | query_params]
else
query_params
end
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Retrieves a list of prompt routers.
"""
@spec list_prompt_routers(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_prompt_routers_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_prompt_routers_errors()}
def list_prompt_routers(
%Client{} = client,
max_results \\ nil,
next_token \\ nil,
type \\ nil,
options \\ []
) do
url_path = "/prompt-routers"
headers = []
query_params = []
query_params =
if !is_nil(type) do
[{"type", type} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
Lists the Provisioned Throughputs in the account.
For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_provisioned_model_throughputs(
map(),
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
String.t() | atom() | nil,
list()
) ::
{:ok, list_provisioned_model_throughputs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_provisioned_model_throughputs_errors()}
def list_provisioned_model_throughputs(
%Client{} = client,
creation_time_after \\ nil,
creation_time_before \\ nil,
max_results \\ nil,
model_arn_equals \\ nil,
name_contains \\ nil,
next_token \\ nil,
sort_by \\ nil,
sort_order \\ nil,
status_equals \\ nil,
options \\ []
) do
url_path = "/provisioned-model-throughputs"
headers = []
query_params = []
query_params =
if !is_nil(status_equals) do
[{"statusEquals", status_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_order) do
[{"sortOrder", sort_order} | query_params]
else
query_params
end
query_params =
if !is_nil(sort_by) do
[{"sortBy", sort_by} | query_params]
else
query_params
end
query_params =
if !is_nil(next_token) do
[{"nextToken", next_token} | query_params]
else
query_params
end
query_params =
if !is_nil(name_contains) do
[{"nameContains", name_contains} | query_params]
else
query_params
end
query_params =
if !is_nil(model_arn_equals) do
[{"modelArnEquals", model_arn_equals} | query_params]
else
query_params
end
query_params =
if !is_nil(max_results) do
[{"maxResults", max_results} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_before) do
[{"creationTimeBefore", creation_time_before} | query_params]
else
query_params
end
query_params =
if !is_nil(creation_time_after) do
[{"creationTimeAfter", creation_time_after} | query_params]
else
query_params
end
meta = metadata()
Request.request_rest(client, meta, :get, url_path, query_params, headers, nil, options, 200)
end
@doc """
List the tags associated with the specified resource.
For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec list_tags_for_resource(map(), list_tags_for_resource_request(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
url_path = "/listTagsForResource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Set the configuration values for model invocation logging.
"""
@spec put_model_invocation_logging_configuration(
map(),
put_model_invocation_logging_configuration_request(),
list()
) ::
{:ok, put_model_invocation_logging_configuration_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_model_invocation_logging_configuration_errors()}
def put_model_invocation_logging_configuration(%Client{} = client, input, options \\ []) do
url_path = "/logging/modelinvocations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Put usecase for model access.
"""
@spec put_use_case_for_model_access(map(), put_use_case_for_model_access_request(), list()) ::
{:ok, put_use_case_for_model_access_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, put_use_case_for_model_access_errors()}
def put_use_case_for_model_access(%Client{} = client, input, options \\ []) do
url_path = "/use-case-for-model-access"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
201
)
end
@doc """
Registers an existing Amazon SageMaker endpoint with Amazon Bedrock Marketplace,
allowing it to be used with Amazon Bedrock APIs.
"""
@spec register_marketplace_model_endpoint(
map(),
String.t() | atom(),
register_marketplace_model_endpoint_request(),
list()
) ::
{:ok, register_marketplace_model_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, register_marketplace_model_endpoint_errors()}
def register_marketplace_model_endpoint(
%Client{} = client,
endpoint_identifier,
input,
options \\ []
) do
url_path =
"/marketplace-model/endpoints/#{AWS.Util.encode_uri(endpoint_identifier)}/registration"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Starts a new build workflow for an Automated Reasoning policy.
This initiates the process of analyzing source documents and generating policy
rules, variables, and types.
"""
@spec start_automated_reasoning_policy_build_workflow(
map(),
String.t() | atom(),
String.t() | atom(),
start_automated_reasoning_policy_build_workflow_request(),
list()
) ::
{:ok, start_automated_reasoning_policy_build_workflow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_automated_reasoning_policy_build_workflow_errors()}
def start_automated_reasoning_policy_build_workflow(
%Client{} = client,
build_workflow_type,
policy_arn,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_type)}/start"
{headers, input} =
[
{"clientRequestToken", "x-amz-client-token"}
]
|> Request.build_params(input)
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Initiates a test workflow to validate Automated Reasoning policy tests.
The workflow executes the specified tests against the policy and generates
validation results.
"""
@spec start_automated_reasoning_policy_test_workflow(
map(),
String.t() | atom(),
String.t() | atom(),
start_automated_reasoning_policy_test_workflow_request(),
list()
) ::
{:ok, start_automated_reasoning_policy_test_workflow_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, start_automated_reasoning_policy_test_workflow_errors()}
def start_automated_reasoning_policy_test_workflow(
%Client{} = client,
build_workflow_id,
policy_arn,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/test-workflows"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Stops an evaluation job that is current being created or running.
"""
@spec stop_evaluation_job(map(), String.t() | atom(), stop_evaluation_job_request(), list()) ::
{:ok, stop_evaluation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_evaluation_job_errors()}
def stop_evaluation_job(%Client{} = client, job_identifier, input, options \\ []) do
url_path = "/evaluation-job/#{AWS.Util.encode_uri(job_identifier)}/stop"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Stops an active model customization job.
For more information, see [Custom models](https://docs.aws.amazon.com/bedrock/latest/userguide/custom-models.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec stop_model_customization_job(
map(),
String.t() | atom(),
stop_model_customization_job_request(),
list()
) ::
{:ok, stop_model_customization_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_model_customization_job_errors()}
def stop_model_customization_job(%Client{} = client, job_identifier, input, options \\ []) do
url_path = "/model-customization-jobs/#{AWS.Util.encode_uri(job_identifier)}/stop"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Stops a batch inference job.
You're only charged for tokens that were already processed. For more
information, see [Stop a batch inference job](https://docs.aws.amazon.com/bedrock/latest/userguide/batch-inference-stop.html).
"""
@spec stop_model_invocation_job(
map(),
String.t() | atom(),
stop_model_invocation_job_request(),
list()
) ::
{:ok, stop_model_invocation_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, stop_model_invocation_job_errors()}
def stop_model_invocation_job(%Client{} = client, job_identifier, input, options \\ []) do
url_path = "/model-invocation-job/#{AWS.Util.encode_uri(job_identifier)}/stop"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Associate tags with a resource.
For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
url_path = "/tagResource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Remove one or more tags from a resource.
For more information, see [Tagging resources](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
url_path = "/untagResource"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:post,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing Automated Reasoning policy with new rules, variables, or
configuration.
This creates a new version of the policy while preserving the previous version.
"""
@spec update_automated_reasoning_policy(
map(),
String.t() | atom(),
update_automated_reasoning_policy_request(),
list()
) ::
{:ok, update_automated_reasoning_policy_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_automated_reasoning_policy_errors()}
def update_automated_reasoning_policy(%Client{} = client, policy_arn, input, options \\ []) do
url_path = "/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the annotations for an Automated Reasoning policy build workflow.
This allows you to modify extracted rules, variables, and types before
finalizing the policy.
"""
@spec update_automated_reasoning_policy_annotations(
map(),
String.t() | atom(),
String.t() | atom(),
update_automated_reasoning_policy_annotations_request(),
list()
) ::
{:ok, update_automated_reasoning_policy_annotations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_automated_reasoning_policy_annotations_errors()}
def update_automated_reasoning_policy_annotations(
%Client{} = client,
build_workflow_id,
policy_arn,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/build-workflows/#{AWS.Util.encode_uri(build_workflow_id)}/annotations"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates an existing Automated Reasoning policy test.
You can modify the content, query, expected result, and confidence threshold.
"""
@spec update_automated_reasoning_policy_test_case(
map(),
String.t() | atom(),
String.t() | atom(),
update_automated_reasoning_policy_test_case_request(),
list()
) ::
{:ok, update_automated_reasoning_policy_test_case_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_automated_reasoning_policy_test_case_errors()}
def update_automated_reasoning_policy_test_case(
%Client{} = client,
policy_arn,
test_case_id,
input,
options \\ []
) do
url_path =
"/automated-reasoning-policies/#{AWS.Util.encode_uri(policy_arn)}/test-cases/#{AWS.Util.encode_uri(test_case_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailTopicConfig.html) 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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html)
object in the `filtersConfig` list pertains to a harmful category. For more
information, see [Content filters](https://docs.aws.amazon.com/bedrock/latest/userguide/guardrails-content-filters).
For more information about the fields in a content filter, see
[GuardrailContentFilterConfig](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html). * 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](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GuardrailContentFilterConfig.html).
* (Optional) For security, include the ARN of a KMS key in the
`kmsKeyId` field.
"""
@spec update_guardrail(map(), String.t() | atom(), update_guardrail_request(), list()) ::
{:ok, update_guardrail_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_guardrail_errors()}
def update_guardrail(%Client{} = client, guardrail_identifier, input, options \\ []) do
url_path = "/guardrails/#{AWS.Util.encode_uri(guardrail_identifier)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:put,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
202
)
end
@doc """
Updates the configuration of an existing endpoint for a model from Amazon
Bedrock Marketplace.
"""
@spec update_marketplace_model_endpoint(
map(),
String.t() | atom(),
update_marketplace_model_endpoint_request(),
list()
) ::
{:ok, update_marketplace_model_endpoint_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_marketplace_model_endpoint_errors()}
def update_marketplace_model_endpoint(%Client{} = client, endpoint_arn, input, options \\ []) do
url_path = "/marketplace-model/endpoints/#{AWS.Util.encode_uri(endpoint_arn)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
@doc """
Updates the name or associated model for a Provisioned Throughput.
For more information, see [Provisioned Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html)
in the [Amazon Bedrock User Guide](https://docs.aws.amazon.com/bedrock/latest/userguide/what-is-service.html).
"""
@spec update_provisioned_model_throughput(
map(),
String.t() | atom(),
update_provisioned_model_throughput_request(),
list()
) ::
{:ok, update_provisioned_model_throughput_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, term()}
| {:error, update_provisioned_model_throughput_errors()}
def update_provisioned_model_throughput(
%Client{} = client,
provisioned_model_id,
input,
options \\ []
) do
url_path = "/provisioned-model-throughput/#{AWS.Util.encode_uri(provisioned_model_id)}"
headers = []
custom_headers = []
query_params = []
meta = metadata()
Request.request_rest(
client,
meta,
:patch,
url_path,
query_params,
custom_headers ++ headers,
input,
options,
200
)
end
end
