Package software.amazon.awssdk.services.bedrockagent.model

Class CreateAgentRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.bedrockagent.model.BedrockAgentRequest

software.amazon.awssdk.services.bedrockagent.model.CreateAgentRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreateAgentRequest
extends BedrockAgentRequest
implements ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateAgentRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	agentName()	A name for the agent that you create.
String	agentResourceRoleArn()	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
static CreateAgentRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	customerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
String	description()	A description of the agent.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	foundationModel()	The foundation model to be used for orchestration by the agent you create.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
Integer	idleSessionTTLInSeconds()	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
String	instruction()	Instructions that tell the agent what it should do and how it should interact with users.
PromptOverrideConfiguration	promptOverrideConfiguration()	Contains configurations to override prompts in different parts of an agent sequence.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateAgentRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	Any tags that you want to attach to the agent.
CreateAgentRequest.Builder	toBuilder()
String	toString()	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

agentName

public final String agentName()

A name for the agent that you create.

Returns:

A name for the agent that you create.

agentResourceRoleArn

public final String agentResourceRoleArn()

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

Returns:

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

clientToken

public final String clientToken()

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.

customerEncryptionKeyArn

public final String customerEncryptionKeyArn()

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

Returns:

The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

description

public final String description()

A description of the agent.

Returns:

A description of the agent.

foundationModel

public final String foundationModel()

The foundation model to be used for orchestration by the agent you create.

Returns:

The foundation model to be used for orchestration by the agent you create.

idleSessionTTLInSeconds

public final Integer idleSessionTTLInSeconds()

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

Returns:

The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

instruction

public final String instruction()

Instructions that tell the agent what it should do and how it should interact with users.

Returns:

Instructions that tell the agent what it should do and how it should interact with users.

promptOverrideConfiguration

public final PromptOverrideConfiguration promptOverrideConfiguration()

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

Returns:

Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.

tags

public final Map<String,String> tags()

Any tags that you want to attach to the agent.

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 hasTags() method.

Returns:

Any tags that you want to attach to the agent.

toBuilder

public CreateAgentRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

Specified by:

toBuilder in class BedrockAgentRequest

builder

public static CreateAgentRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateAgentRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo