String jobName
The name of the model evaluation job. Model evaluation job names must unique with your AWS account, and your account's AWS region.
String jobDescription
A description of the model evaluation job.
String clientRequestToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
String roleArn
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your
behalf. The service role must have Amazon Bedrock as the service principal, and provide access to any Amazon S3
buckets specified in the EvaluationConfig object. To pass this role to Amazon Bedrock, the caller of
this API must have the iam:PassRole permission. To learn more about the required permissions, see Required
permissions.
String customerEncryptionKeyId
Specify your customer managed key ARN that will be used to encrypt your model evaluation job.
List<E> jobTags
Tags to attach to the model evaluation job.
EvaluationConfig evaluationConfig
Specifies whether the model evaluation job is automatic or uses human worker.
EvaluationInferenceConfig inferenceConfig
Specify the models you want to use in your model evaluation job. Automatic model evaluation jobs support a single model, and model evaluation job that use human workers support two models.
EvaluationOutputDataConfig outputDataConfig
An object that defines where the results of model evaluation job will be saved in Amazon S3.
String jobArn
The ARN of the model evaluation job.
String name
The name to give the guardrail.
String description
A description of the guardrail.
GuardrailTopicPolicyConfig topicPolicyConfig
The topic policies to configure for the guardrail.
GuardrailContentPolicyConfig contentPolicyConfig
The content filter policies to configure for the guardrail.
GuardrailWordPolicyConfig wordPolicyConfig
The word policy you configure for the guardrail.
GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig
The sensitive information policy to configure for the guardrail.
GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig
The contextual grounding policy configuration used to create a guardrail.
String blockedInputMessaging
The message to return when the guardrail blocks a prompt.
String blockedOutputsMessaging
The message to return when the guardrail blocks a model response.
String kmsKeyId
The ARN of the KMS key that you use to encrypt the guardrail.
List<E> tags
The tags that you want to attach to the guardrail.
String clientRequestToken
A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
String guardrailId
The unique identifier of the guardrail that was created.
String guardrailArn
The ARN of the guardrail.
String version
The version of the guardrail that was created. This value will always be DRAFT.
Date createdAt
The time at which the guardrail was created.
String guardrailIdentifier
The unique identifier of the guardrail. This can be an ID or the ARN.
String description
A description of the guardrail version.
String clientRequestToken
A unique, case-sensitive identifier to ensure that the API request completes no more than once. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
String jobName
A name for the fine-tuning job.
String customModelName
A name for the resulting custom model.
String roleArn
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock can assume to perform tasks on your
behalf. For example, during model training, Amazon Bedrock needs your permission to read input data from an S3
bucket, write model artifacts to an S3 bucket. To pass this role to Amazon Bedrock, the caller of this API must
have the iam:PassRole permission.
String clientRequestToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
String baseModelIdentifier
Name of the base model.
String customizationType
The customization type.
String customModelKmsKeyId
The custom model is encrypted at rest using this key.
List<E> jobTags
Tags to attach to the job.
List<E> customModelTags
Tags to attach to the resulting custom model.
TrainingDataConfig trainingDataConfig
Information about the training dataset.
ValidationDataConfig validationDataConfig
Information about the validation dataset.
OutputDataConfig outputDataConfig
S3 location for the output data.
Map<K,V> hyperParameters
Parameters related to tuning the model. For details on the format for different models, see Custom model hyperparameters.
VpcConfig vpcConfig
VPC configuration (optional). Configuration parameters for the private Virtual Private Cloud (VPC) that contains the resources you are using for this job.
String jobArn
Amazon Resource Name (ARN) of the fine tuning job
String clientRequestToken
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency in the Amazon S3 User Guide.
Integer modelUnits
Number of model units to allocate. A model unit delivers a specific throughput level for the specified model. The throughput level of a model unit specifies the total number of input and output tokens that it can process and generate within a span of one minute. By default, your account has no model units for purchasing Provisioned Throughputs with commitment. You must first visit the Amazon Web Services support center to request MUs.
For model unit quotas, see Provisioned Throughput quotas in the Amazon Bedrock User Guide.
For more information about what an MU specifies, contact your Amazon Web Services account manager.
String provisionedModelName
The name for this Provisioned Throughput.
String modelId
The Amazon Resource Name (ARN) or name of the model to associate with this Provisioned Throughput. For a list of models for which you can purchase Provisioned Throughput, see Amazon Bedrock model IDs for purchasing Provisioned Throughput in the Amazon Bedrock User Guide.
String commitmentDuration
The commitment duration requested for the Provisioned Throughput. Billing occurs hourly and is discounted for longer commitment terms. To request a no-commit Provisioned Throughput, omit this field.
Custom models support all levels of commitment. To see which base models support no commitment, see Supported regions and models for Provisioned Throughput in the Amazon Bedrock User Guide
List<E> tags
Tags to associate with this Provisioned Throughput.
String provisionedModelArn
The Amazon Resource Name (ARN) for this Provisioned Throughput.
String modelArn
The Amazon Resource Name (ARN) of the custom model.
String modelName
The name of the custom model.
Date creationTime
Creation time of the model.
String baseModelArn
The base model Amazon Resource Name (ARN).
String baseModelName
The base model name.
String customizationType
Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
String modelIdentifier
Name of the model to delete.
String provisionedModelId
The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
AutomatedEvaluationConfig automated
Used to specify an automated model evaluation job. See AutomatedEvaluationConfig to view the
required parameters.
HumanEvaluationConfig human
Used to specify a model evaluation job that uses human workers.See HumanEvaluationConfig to view the
required parameters.
String name
Used to specify supported built-in prompt datasets. Valid values are Builtin.Bold,
Builtin.BoolQ, Builtin.NaturalQuestions, Builtin.Gigaword,
Builtin.RealToxicityPrompts, Builtin.TriviaQa, Builtin.T-Rex,
Builtin.WomensEcommerceClothingReviews and Builtin.Wikitext2.
EvaluationDatasetLocation datasetLocation
For custom prompt datasets, you must specify the location in Amazon S3 where the prompt dataset is saved.
String s3Uri
The S3 URI of the S3 bucket specified in the job.
String taskType
The task type you want the model to carry out.
EvaluationDataset dataset
Specifies the prompt dataset.
List<E> metricNames
The names of the metrics used. For automated model evaluation jobs valid values are
"Builtin.Accuracy", "Builtin.Robustness", and "Builtin.Toxicity". In
human-based model evaluation jobs the array of strings must match the name parameter specified in
HumanEvaluationCustomMetric.
EvaluationBedrockModel bedrockModel
Defines the Amazon Bedrock model and inference parameters you want used.
String s3Uri
The Amazon S3 URI where the results of model evaluation job are saved.
String jobArn
The Amazon Resource Name (ARN) of the model evaluation job.
String jobName
The name of the model evaluation job.
String status
The current status of the model evaluation job.
Date creationTime
When the model evaluation job was created.
String jobType
The type, either human or automatic, of model evaluation job.
List<E> evaluationTaskTypes
What task type was used in the model evaluation job.
List<E> modelIdentifiers
The Amazon Resource Names (ARNs) of the model(s) used in the model evaluation job.
String modelArn
The model Amazon Resource Name (ARN).
String modelId
The model identifier.
String modelName
The model name.
String providerName
The model's provider name.
List<E> inputModalities
The input modalities that the model supports.
List<E> outputModalities
The output modalities that the model supports.
Boolean responseStreamingSupported
Indicates whether the model supports streaming.
List<E> customizationsSupported
The customization that the model supports.
List<E> inferenceTypesSupported
The inference types that the model supports.
FoundationModelLifecycle modelLifecycle
Contains details about whether a model version is available or deprecated
String status
Specifies whether a model version is available (ACTIVE) or deprecated (LEGACY.
String modelArn
The Amazon Resource Name (ARN) of the foundation model.
String modelId
The model ID of the foundation model.
String modelName
The name of the model.
String providerName
The model's provider name.
List<E> inputModalities
The input modalities that the model supports.
List<E> outputModalities
The output modalities that the model supports.
Boolean responseStreamingSupported
Indicates whether the model supports streaming.
List<E> customizationsSupported
Whether the model supports fine-tuning or continual pre-training.
List<E> inferenceTypesSupported
The inference types that the model supports.
FoundationModelLifecycle modelLifecycle
Contains details about whether a model version is available or deprecated.
String modelIdentifier
Name or Amazon Resource Name (ARN) of the custom model.
String modelArn
Amazon Resource Name (ARN) associated with this model.
String modelName
Model name associated with this model.
String jobName
Job name associated with this model.
String jobArn
Job Amazon Resource Name (ARN) associated with this model.
String baseModelArn
Amazon Resource Name (ARN) of the base model.
String customizationType
The type of model customization.
String modelKmsKeyArn
The custom model is encrypted at rest using this key.
Map<K,V> hyperParameters
Hyperparameter values associated with this model. For details on the format for different models, see Custom model hyperparameters.
TrainingDataConfig trainingDataConfig
Contains information about the training dataset.
ValidationDataConfig validationDataConfig
Contains information about the validation dataset.
OutputDataConfig outputDataConfig
Output data configuration associated with this custom model.
TrainingMetrics trainingMetrics
Contains training metrics from the job creation.
List<E> validationMetrics
The validation metrics from the job creation.
Date creationTime
Creation time of the model.
String jobIdentifier
The Amazon Resource Name (ARN) of the model evaluation job.
String jobName
The name of the model evaluation job.
String status
The status of the model evaluation job.
String jobArn
The Amazon Resource Name (ARN) of the model evaluation job.
String jobDescription
The description of the model evaluation job.
String roleArn
The Amazon Resource Name (ARN) of the IAM service role used in the model evaluation job.
String customerEncryptionKeyId
The Amazon Resource Name (ARN) of the customer managed key specified when the model evaluation job was created.
String jobType
The type of model evaluation job.
EvaluationConfig evaluationConfig
Contains details about the type of model evaluation job, the metrics used, the task type selected, the datasets used, and any custom metrics you defined.
EvaluationInferenceConfig inferenceConfig
Details about the models you specified in your model evaluation job.
EvaluationOutputDataConfig outputDataConfig
Amazon S3 location for where output data is saved.
Date creationTime
When the model evaluation job was created.
Date lastModifiedTime
When the model evaluation job was last modified.
List<E> failureMessages
An array of strings the specify why the model evaluation job has failed.
String modelIdentifier
The model identifier.
FoundationModelDetails modelDetails
Information about the foundation model.
String guardrailIdentifier
The unique identifier of the guardrail for which to get details. This can be an ID or the ARN.
String guardrailVersion
The version of the guardrail for which to get details. If you don't specify a version, the response returns
details for the DRAFT version.
String name
The name of the guardrail.
String description
The description of the guardrail.
String guardrailId
The unique identifier of the guardrail.
String guardrailArn
The ARN of the guardrail.
String version
The version of the guardrail.
String status
The status of the guardrail.
GuardrailTopicPolicy topicPolicy
The topic policy that was configured for the guardrail.
GuardrailContentPolicy contentPolicy
The content policy that was configured for the guardrail.
GuardrailWordPolicy wordPolicy
The word policy that was configured for the guardrail.
GuardrailSensitiveInformationPolicy sensitiveInformationPolicy
The sensitive information policy that was configured for the guardrail.
GuardrailContextualGroundingPolicy contextualGroundingPolicy
The contextual grounding policy used in the guardrail.
Date createdAt
The date and time at which the guardrail was created.
Date updatedAt
The date and time at which the guardrail was updated.
List<E> statusReasons
Appears if the status is FAILED. A list of reasons for why the guardrail failed to be
created, updated, versioned, or deleted.
List<E> failureRecommendations
Appears if the status of the guardrail is FAILED. A list of recommendations to carry
out before retrying the request.
String blockedInputMessaging
The message that the guardrail returns when it blocks a prompt.
String blockedOutputsMessaging
The message that the guardrail returns when it blocks a model response.
String kmsKeyArn
The ARN of the KMS key that encrypts the guardrail.
String jobIdentifier
Identifier for the customization job.
String jobArn
The Amazon Resource Name (ARN) of the customization job.
String jobName
The name of the customization job.
String outputModelName
The name of the output model.
String outputModelArn
The Amazon Resource Name (ARN) of the output model.
String clientRequestToken
The token that you specified in the CreateCustomizationJob request.
String roleArn
The Amazon Resource Name (ARN) of the IAM role.
String status
The status of the job. A successful job transitions from in-progress to completed when the output model is ready to use. If the job failed, the failure message contains information about why the job failed.
String failureMessage
Information about why the job failed.
Date creationTime
Time that the resource was created.
Date lastModifiedTime
Time that the resource was last modified.
Date endTime
Time that the resource transitioned to terminal state.
String baseModelArn
Amazon Resource Name (ARN) of the base model.
Map<K,V> hyperParameters
The hyperparameter values for the job. For details on the format for different models, see Custom model hyperparameters.
TrainingDataConfig trainingDataConfig
Contains information about the training dataset.
ValidationDataConfig validationDataConfig
Contains information about the validation dataset.
OutputDataConfig outputDataConfig
Output data configuration
String customizationType
The type of model customization.
String outputModelKmsKeyArn
The custom model is encrypted at rest using this key.
TrainingMetrics trainingMetrics
Contains training metrics from the job creation.
List<E> validationMetrics
The loss metric for each validator that you provided in the createjob request.
VpcConfig vpcConfig
VPC configuration for the custom model job.
LoggingConfig loggingConfig
The current configuration values.
String provisionedModelId
The Amazon Resource Name (ARN) or name of the Provisioned Throughput.
Integer modelUnits
The number of model units allocated to this Provisioned Throughput.
Integer desiredModelUnits
The number of model units that was requested for this Provisioned Throughput.
String provisionedModelName
The name of the Provisioned Throughput.
String provisionedModelArn
The Amazon Resource Name (ARN) of the Provisioned Throughput.
String modelArn
The Amazon Resource Name (ARN) of the model associated with this Provisioned Throughput.
String desiredModelArn
The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value
differs from the modelArn if updating hasn't completed.
String foundationModelArn
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
String status
The status of the Provisioned Throughput.
Date creationTime
The timestamp of the creation time for this Provisioned Throughput.
Date lastModifiedTime
The timestamp of the last time that this Provisioned Throughput was modified.
String failureMessage
A failure message for any issues that occurred during creation, updating, or deletion of the Provisioned Throughput.
String commitmentDuration
Commitment duration of the Provisioned Throughput.
Date commitmentExpirationTime
The timestamp for when the commitment term for the Provisioned Throughput expires.
String type
The harmful category that the content filter is applied to.
String inputStrength
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
String outputStrength
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
String type
The harmful category that the content filter is applied to.
String inputStrength
The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
String outputStrength
The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
String type
ManagedWords$type The managed word type that was configured for the guardrail. (For now, we only offer profanity word list)
String type
The managed word type to configure for the guardrail.
String type
Configure guardrail type when the PII entity is detected.
The following PIIs are used to block or mask sensitive information:
General
ADDRESS
A physical address, such as "100 Main Street, Anytown, USA" or "Suite #12, Building 123". An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.
AGE
An individual's age, including the quantity and unit of time. For example, in the phrase "I am 40 years old," Guarrails recognizes "40 years" as an age.
NAME
An individual's name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. guardrails doesn't apply this entity type to names that are part of organizations or addresses. For example, guardrails recognizes the "John Doe Organization" as an organization, and it recognizes "Jane Doe Street" as an address.
An email address, such as marymajor@email.com.
PHONE
A phone number. This entity type also includes fax and pager numbers.
USERNAME
A user name that identifies an account, such as a login name, screen name, nick name, or handle.
PASSWORD
An alphanumeric string that is used as a password, such as "*very20special#pass*".
DRIVER_ID
The number assigned to a driver's license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver's license number consists of alphanumeric characters.
LICENSE_PLATE
A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.
VEHICLE_IDENTIFICATION_NUMBER
A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.
Finance
REDIT_DEBIT_CARD_CVV
A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.
CREDIT_DEBIT_CARD_EXPIRY
The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY. Guardrails recognizes expiration dates such as 01/21, 01/2021, and Jan 2021.
CREDIT_DEBIT_CARD_NUMBER
The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.
PIN
A four-digit personal identification number (PIN) with which you can access your bank account.
INTERNATIONAL_BANK_ACCOUNT_NUMBER
An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure.
SWIFT_CODE
A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.
SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in 'XXX') refer to the head or primary office.
IT
IP_ADDRESS
An IPv4 address, such as 198.51.100.0.
MAC_ADDRESS
A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).
URL
A web address, such as www.example.com.
AWS_ACCESS_KEY
A unique identifier that's associated with a secret access key; you use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
AWS_SECRET_KEY
A unique identifier that's associated with an access key. You use the access key ID and secret access key to sign programmatic Amazon Web Services requests cryptographically.
USA specific
US_BANK_ACCOUNT_NUMBER
A US bank account number, which is typically 10 to 12 digits long.
US_BANK_ROUTING_NUMBER
A US bank account routing number. These are typically nine digits long,
US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a "9" and contain a "7" or "8" as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.
US_PASSPORT_NUMBER
A US passport number. Passport numbers range from six to nine alphanumeric characters.
US_SOCIAL_SECURITY_NUMBER
A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.
Canada specific
CA_HEALTH_NUMBER
A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.
CA_SOCIAL_INSURANCE_NUMBER
A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.
The SIN is formatted as three groups of three digits, such as 123-456-789. A SIN can be validated through a simple check-digit process called the Luhn algorithm.
UK Specific
UK_NATIONAL_HEALTH_SERVICE_NUMBER
A UK National Health Service Number is a 10-17 digit number, such as 485 777 3456. The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.
UK_NATIONAL_INSURANCE_NUMBER
A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.
The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.
UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.
Custom
Regex filter - You can use a regular expressions to define patterns for a guardrail to recognize and act upon such as serial number, booking ID etc..
String action
Configure guardrail action when the PII entity is detected.
String name
The name of the regular expression for the guardrail.
String description
The description of the regular expression for the guardrail.
String pattern
The pattern of the regular expression configured for the guardrail.
String action
The action taken when a match to the regular expression is detected.
String name
The name of the regular expression to configure for the guardrail.
String description
The description of the regular expression to configure for the guardrail.
String pattern
The regular expression pattern to configure for the guardrail.
String action
The guardrail action to configure when matching regular expression is detected.
String id
The unique identifier of the guardrail.
String arn
The ARN of the guardrail.
String status
The status of the guardrail.
String name
The name of the guardrail.
String description
A description of the guardrail.
String version
The version of the guardrail.
Date createdAt
The date and time at which the guardrail was created.
Date updatedAt
The date and time at which the guardrail was last updated.
String text
Text of the word configured for the guardrail to block.
String text
Text of the word configured for the guardrail to block.
HumanWorkflowConfig humanWorkflowConfig
The parameters of the human workflow.
List<E> customMetrics
A HumanEvaluationCustomMetric object. It contains the names the metrics, how the metrics are to be
evaluated, an optional description.
List<E> datasetMetricConfigs
Use to specify the metrics, task, and prompt dataset to be used in your model evaluation job.
String name
The name of the metric. Your human evaluators will see this name in the evaluation UI.
String description
An optional description of the metric. Use this parameter to provide more details about the metric.
String ratingMethod
Choose how you want your human workers to evaluation your model. Valid values for rating methods are
ThumbsUpDown, IndividualLikertScale,ComparisonLikertScale,
ComparisonChoice, and ComparisonRank
Date creationTimeBefore
Return custom models created before the specified time.
Date creationTimeAfter
Return custom models created after the specified time.
String nameContains
Return custom models only if the job name contains these characters.
String baseModelArnEquals
Return custom models only if the base model Amazon Resource Name (ARN) matches this parameter.
String foundationModelArnEquals
Return custom models only if the foundation model Amazon Resource Name (ARN) matches this parameter.
Integer maxResults
Maximum number of results to return in the response.
String nextToken
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
String sortBy
The field to sort by in the returned list of models.
String sortOrder
The sort order of the results.
Date creationTimeAfter
A filter that includes model evaluation jobs created after the time specified.
Date creationTimeBefore
A filter that includes model evaluation jobs created prior to the time specified.
String statusEquals
Only return jobs where the status condition is met.
String nameContains
Query parameter string for model evaluation job names.
Integer maxResults
The maximum number of results to return.
String nextToken
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
String sortBy
Allows you to sort model evaluation jobs by when they were created.
String sortOrder
How you want the order of jobs sorted.
String byProvider
Return models belonging to the model provider that you specify.
String byCustomizationType
Return models that support the customization type that you specify. For more information, see Custom models in the Amazon Bedrock User Guide.
String byOutputModality
Return models that support the output modality that you specify.
String byInferenceType
Return models that support the inference type that you specify. For more information, see Provisioned Throughput in the Amazon Bedrock User Guide.
String guardrailIdentifier
The unique identifier of the guardrail. This can be an ID or the ARN.
Integer maxResults
The maximum number of results to return in the response.
String nextToken
If there are more results than were returned in the response, the response returns a nextToken that
you can send in another ListGuardrails request to see the next batch of results.
List<E> guardrails
A list of objects, each of which contains details about a guardrail.
String nextToken
If there are more results than were returned in the response, the response returns a nextToken that
you can send in another ListGuardrails request to see the next batch of results.
Date creationTimeAfter
Return customization jobs created after the specified time.
Date creationTimeBefore
Return customization jobs created before the specified time.
String statusEquals
Return customization jobs with the specified status.
String nameContains
Return customization jobs only if the job name contains these characters.
Integer maxResults
Maximum number of results to return in the response.
String nextToken
Continuation token from the previous response, for Amazon Bedrock to list the next set of results.
String sortBy
The field to sort by in the returned list of jobs.
String sortOrder
The sort order of the results.
Date creationTimeAfter
A filter that returns Provisioned Throughputs created after the specified time.
Date creationTimeBefore
A filter that returns Provisioned Throughputs created before the specified time.
String statusEquals
A filter that returns Provisioned Throughputs if their statuses matches the value that you specify.
String modelArnEquals
A filter that returns Provisioned Throughputs whose model Amazon Resource Name (ARN) is equal to the value that you specify.
String nameContains
A filter that returns Provisioned Throughputs if their name contains the expression that you specify.
Integer maxResults
THe maximum number of results to return in the response. If there are more results than the number you specified,
the response returns a nextToken value. To see the next batch of results, send the
nextToken value in another list request.
String nextToken
If there are more results than the number you specified in the maxResults field, the response
returns a nextToken value. To see the next batch of results, specify the nextToken
value in this field.
String sortBy
The field by which to sort the returned list of Provisioned Throughputs.
String sortOrder
The sort order of the results.
String nextToken
If there are more results than the number you specified in the maxResults field, this value is
returned. To see the next batch of results, include this value in the nextToken field in another
list request.
List<E> provisionedModelSummaries
A list of summaries, one for each Provisioned Throughput in the response.
String resourceARN
The Amazon Resource Name (ARN) of the resource.
CloudWatchConfig cloudWatchConfig
CloudWatch logging configuration.
S3Config s3Config
S3 configuration for storing log data.
Boolean textDataDeliveryEnabled
Set to include text data in the log delivery.
Boolean imageDataDeliveryEnabled
Set to include image data in the log delivery.
Boolean embeddingDataDeliveryEnabled
Set to include embeddings data in the log delivery.
String jobArn
Amazon Resource Name (ARN) of the customization job.
String baseModelArn
Amazon Resource Name (ARN) of the base model.
String jobName
Name of the customization job.
String status
Status of the customization job.
Date lastModifiedTime
Time that the customization job was last modified.
Date creationTime
Creation time of the custom model.
Date endTime
Time that the customization job ended.
String customModelArn
Amazon Resource Name (ARN) of the custom model.
String customModelName
Name of the custom model.
String customizationType
Specifies whether to carry out continued pre-training of a model or whether to fine-tune it. For more information, see Custom models.
String s3Uri
The S3 URI where the output data is stored.
String provisionedModelName
The name of the Provisioned Throughput.
String provisionedModelArn
The Amazon Resource Name (ARN) of the Provisioned Throughput.
String modelArn
The Amazon Resource Name (ARN) of the model associated with the Provisioned Throughput.
String desiredModelArn
The Amazon Resource Name (ARN) of the model requested to be associated to this Provisioned Throughput. This value
differs from the modelArn if updating hasn't completed.
String foundationModelArn
The Amazon Resource Name (ARN) of the base model for which the Provisioned Throughput was created, or of the base model that the custom model for which the Provisioned Throughput was created was customized.
Integer modelUnits
The number of model units allocated to the Provisioned Throughput.
Integer desiredModelUnits
The number of model units that was requested to be allocated to the Provisioned Throughput.
String status
The status of the Provisioned Throughput.
String commitmentDuration
The duration for which the Provisioned Throughput was committed.
Date commitmentExpirationTime
The timestamp for when the commitment term of the Provisioned Throughput expires.
Date creationTime
The time that the Provisioned Throughput was created.
Date lastModifiedTime
The time that the Provisioned Throughput was last modified.
LoggingConfig loggingConfig
The logging configuration values to set.
String jobIdentifier
The ARN of the model evaluation job you want to stop.
String jobIdentifier
Job identifier of the job to stop.
String resourceName
The name of the resource with too many tags.
String s3Uri
The S3 URI where the training data is stored.
Float trainingLoss
Loss metric associated with the custom job.
String guardrailIdentifier
The unique identifier of the guardrail. This can be an ID or the ARN.
String name
A name for the guardrail.
String description
A description of the guardrail.
GuardrailTopicPolicyConfig topicPolicyConfig
The topic policy to configure for the guardrail.
GuardrailContentPolicyConfig contentPolicyConfig
The content policy to configure for the guardrail.
GuardrailWordPolicyConfig wordPolicyConfig
The word policy to configure for the guardrail.
GuardrailSensitiveInformationPolicyConfig sensitiveInformationPolicyConfig
The sensitive information policy to configure for the guardrail.
GuardrailContextualGroundingPolicyConfig contextualGroundingPolicyConfig
The contextual grounding policy configuration used to update a guardrail.
String blockedInputMessaging
The message to return when the guardrail blocks a prompt.
String blockedOutputsMessaging
The message to return when the guardrail blocks a model response.
String kmsKeyId
The ARN of the KMS key with which to encrypt the guardrail.
String provisionedModelId
The Amazon Resource Name (ARN) or name of the Provisioned Throughput to update.
String desiredProvisionedModelName
The new name for this Provisioned Throughput.
String desiredModelId
The Amazon Resource Name (ARN) of the new model to associate with this Provisioned Throughput. You can't specify this field if this Provisioned Throughput is associated with a base model.
If this Provisioned Throughput is associated with a custom model, you can specify one of the following options:
The base model from which the custom model was customized.
Another custom model that was customized from the same base model as the custom model.
String s3Uri
The S3 URI where the validation data is stored.
Float validationLoss
The validation loss associated with this validator.
Copyright © 2025. All rights reserved.