Class CreateCustomModelRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.bedrock.model.BedrockRequest
-
- software.amazon.awssdk.services.bedrock.model.CreateCustomModelRequest
-
- All Implemented Interfaces:
SdkPojo,ToCopyableBuilder<CreateCustomModelRequest.Builder,CreateCustomModelRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateCustomModelRequest extends BedrockRequest implements ToCopyableBuilder<CreateCustomModelRequest.Builder,CreateCustomModelRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceCreateCustomModelRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateCustomModelRequest.Builderbuilder()StringclientRequestToken()A unique, case-sensitive identifier to ensure that the API request completes no more than one time.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)inthashCode()booleanhasModelTags()For responses, this returns true if the service returned a value for the ModelTags property.StringmodelKmsKeyArn()The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model.StringmodelName()A unique name for the custom model.ModelDataSourcemodelSourceConfig()The data source for the model.List<Tag>modelTags()A list of key-value pairs to associate with the custom model resource.StringroleArn()The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends CreateCustomModelRequest.Builder>serializableBuilderClass()CreateCustomModelRequest.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
modelName
public final String modelName()
A unique name for the custom model.
- Returns:
- A unique name for the custom model.
-
modelSourceConfig
public final ModelDataSource modelSourceConfig()
The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.
- Returns:
- The data source for the model. The Amazon S3 URI in the model source must be for the Amazon-managed Amazon S3 bucket containing your model artifacts.
-
modelKmsKeyArn
public final String modelKmsKeyArn()
The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.
If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.
- Returns:
- The Amazon Resource Name (ARN) of the customer managed KMS key to encrypt the custom model. If you don't
provide a KMS key, Amazon Bedrock uses an Amazon Web Services-managed KMS key to encrypt the model.
If you provide a customer managed KMS key, your Amazon Bedrock service role must have permissions to use it. For more information see Encryption of imported models.
-
roleArn
public final String roleArn()
The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.
- Returns:
- The Amazon Resource Name (ARN) of an IAM service role that Amazon Bedrock assumes to perform tasks on your behalf. This role must have permissions to access the Amazon S3 bucket containing your model artifacts and the KMS key (if specified). For more information, see Setting up an IAM service role for importing models in the Amazon Bedrock User Guide.
-
hasModelTags
public final boolean hasModelTags()
For responses, this returns true if the service returned a value for the ModelTags property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
modelTags
public final List<Tag> modelTags()
A list of key-value pairs to associate with the custom model resource. You can use these tags to organize and identify your resources.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasModelTags()method.- Returns:
- A list of key-value pairs to associate with the custom model resource. You can use these tags to organize
and identify your resources.
For more information, see Tagging resources in the Amazon Bedrock User Guide.
-
clientRequestToken
public final 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.
- Returns:
- 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.
-
toBuilder
public CreateCustomModelRequest.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<CreateCustomModelRequest.Builder,CreateCustomModelRequest>- Specified by:
toBuilderin classBedrockRequest
-
builder
public static CreateCustomModelRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateCustomModelRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-