com.amazonaws.services.bedrockagent.model

Class CreateAgentRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.bedrockagent.model.CreateAgentRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateAgentRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateAgentRequest()

Method Summary

Modifier and Type	Method and Description
CreateAgentRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateAgentRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateAgentRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getAgentName() A name for the agent that you create.
String	getAgentResourceRoleArn() The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
String	getClientToken() A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
String	getCustomerEncryptionKeyArn() The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
String	getDescription() A description of the agent.
String	getFoundationModel() The foundation model to be used for orchestration by the agent you create.
GuardrailConfiguration	getGuardrailConfiguration() The unique Guardrail configuration assigned to the agent when it is created.
Integer	getIdleSessionTTLInSeconds() The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
String	getInstruction() Instructions that tell the agent what it should do and how it should interact with users.
MemoryConfiguration	getMemoryConfiguration() Contains the details of the memory configured for the agent.
PromptOverrideConfiguration	getPromptOverrideConfiguration() Contains configurations to override prompts in different parts of an agent sequence.
Map<String,String>	getTags() Any tags that you want to attach to the agent.
int	hashCode()
void	setAgentName(String agentName) A name for the agent that you create.
void	setAgentResourceRoleArn(String agentResourceRoleArn) The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
void	setClientToken(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
void	setCustomerEncryptionKeyArn(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
void	setDescription(String description) A description of the agent.
void	setFoundationModel(String foundationModel) The foundation model to be used for orchestration by the agent you create.
void	setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration) The unique Guardrail configuration assigned to the agent when it is created.
void	setIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
void	setInstruction(String instruction) Instructions that tell the agent what it should do and how it should interact with users.
void	setMemoryConfiguration(MemoryConfiguration memoryConfiguration) Contains the details of the memory configured for the agent.
void	setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration) Contains configurations to override prompts in different parts of an agent sequence.
void	setTags(Map<String,String> tags) Any tags that you want to attach to the agent.
String	toString() Returns a string representation of this object.
CreateAgentRequest	withAgentName(String agentName) A name for the agent that you create.
CreateAgentRequest	withAgentResourceRoleArn(String agentResourceRoleArn) The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
CreateAgentRequest	withClientToken(String clientToken) A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
CreateAgentRequest	withCustomerEncryptionKeyArn(String customerEncryptionKeyArn) The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
CreateAgentRequest	withDescription(String description) A description of the agent.
CreateAgentRequest	withFoundationModel(String foundationModel) The foundation model to be used for orchestration by the agent you create.
CreateAgentRequest	withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration) The unique Guardrail configuration assigned to the agent when it is created.
CreateAgentRequest	withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds) The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
CreateAgentRequest	withInstruction(String instruction) Instructions that tell the agent what it should do and how it should interact with users.
CreateAgentRequest	withMemoryConfiguration(MemoryConfiguration memoryConfiguration) Contains the details of the memory configured for the agent.
CreateAgentRequest	withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration) Contains configurations to override prompts in different parts of an agent sequence.
CreateAgentRequest	withTags(Map<String,String> tags) Any tags that you want to attach to the agent.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateAgentRequest

public CreateAgentRequest()

Method Detail

setAgentName

public void setAgentName(String agentName)

A name for the agent that you create.

Parameters:

agentName - A name for the agent that you create.

getAgentName

public String getAgentName()

A name for the agent that you create.

Returns:

A name for the agent that you create.

withAgentName

public CreateAgentRequest withAgentName(String agentName)

A name for the agent that you create.

Parameters:

agentName - A name for the agent that you create.

Returns:

Returns a reference to this object so that method calls can be chained together.

setAgentResourceRoleArn

public void setAgentResourceRoleArn(String agentResourceRoleArn)

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

Parameters:

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

getAgentResourceRoleArn

public String getAgentResourceRoleArn()

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.

withAgentResourceRoleArn

public CreateAgentRequest withAgentResourceRoleArn(String agentResourceRoleArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setClientToken

public void setClientToken(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.

Parameters:

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.

getClientToken

public String getClientToken()

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.

withClientToken

public CreateAgentRequest withClientToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setCustomerEncryptionKeyArn

public void setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)

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

Parameters:

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

getCustomerEncryptionKeyArn

public String getCustomerEncryptionKeyArn()

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.

withCustomerEncryptionKeyArn

public CreateAgentRequest withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setDescription

public void setDescription(String description)

A description of the agent.

Parameters:

description - A description of the agent.

getDescription

public String getDescription()

A description of the agent.

Returns:

A description of the agent.

withDescription

public CreateAgentRequest withDescription(String description)

A description of the agent.

Parameters:

description - A description of the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setFoundationModel

public void setFoundationModel(String foundationModel)

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

Parameters:

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

getFoundationModel

public String getFoundationModel()

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.

withFoundationModel

public CreateAgentRequest withFoundationModel(String foundationModel)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setGuardrailConfiguration

public void setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

The unique Guardrail configuration assigned to the agent when it is created.

Parameters:

guardrailConfiguration - The unique Guardrail configuration assigned to the agent when it is created.

getGuardrailConfiguration

public GuardrailConfiguration getGuardrailConfiguration()

The unique Guardrail configuration assigned to the agent when it is created.

Returns:

The unique Guardrail configuration assigned to the agent when it is created.

withGuardrailConfiguration

public CreateAgentRequest withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

The unique Guardrail configuration assigned to the agent when it is created.

Parameters:

guardrailConfiguration - The unique Guardrail configuration assigned to the agent when it is created.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIdleSessionTTLInSeconds

public void setIdleSessionTTLInSeconds(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.

Parameters:

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.

getIdleSessionTTLInSeconds

public Integer getIdleSessionTTLInSeconds()

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.

withIdleSessionTTLInSeconds

public CreateAgentRequest withIdleSessionTTLInSeconds(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setInstruction

public void setInstruction(String instruction)

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

Parameters:

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

getInstruction

public String getInstruction()

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.

withInstruction

public CreateAgentRequest withInstruction(String instruction)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMemoryConfiguration

public void setMemoryConfiguration(MemoryConfiguration memoryConfiguration)

Contains the details of the memory configured for the agent.

Parameters:

memoryConfiguration - Contains the details of the memory configured for the agent.

getMemoryConfiguration

public MemoryConfiguration getMemoryConfiguration()

Contains the details of the memory configured for the agent.

Returns:

Contains the details of the memory configured for the agent.

withMemoryConfiguration

public CreateAgentRequest withMemoryConfiguration(MemoryConfiguration memoryConfiguration)

Contains the details of the memory configured for the agent.

Parameters:

memoryConfiguration - Contains the details of the memory configured for the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPromptOverrideConfiguration

public void setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)

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

Parameters:

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

getPromptOverrideConfiguration

public PromptOverrideConfiguration getPromptOverrideConfiguration()

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.

withPromptOverrideConfiguration

public CreateAgentRequest withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public Map<String,String> getTags()

Any tags that you want to attach to the agent.

Returns:

Any tags that you want to attach to the agent.

setTags

public void setTags(Map<String,String> tags)

Any tags that you want to attach to the agent.

Parameters:

tags - Any tags that you want to attach to the agent.

withTags

public CreateAgentRequest withTags(Map<String,String> tags)

Any tags that you want to attach to the agent.

Parameters:

tags - Any tags that you want to attach to the agent.

Returns:

Returns a reference to this object so that method calls can be chained together.

addTagsEntry

public CreateAgentRequest addTagsEntry(String key,
                                       String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateAgentRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateAgentRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()