Agent (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.bedrockagent.model.Agent

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

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

Contains details about an agent.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Agent()

Constructors
Constructor and Description
`Agent()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Agent`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAgentArn()` The Amazon Resource Name (ARN) of the agent.
`String`	`getAgentId()` The unique identifier of the agent.
`String`	`getAgentName()` The name of the agent.
`String`	`getAgentResourceRoleArn()` The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
`String`	`getAgentStatus()` The status of the agent and whether it is ready for use.
`String`	`getAgentVersion()` The version of the agent.
`String`	`getClientToken()` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`Date`	`getCreatedAt()` The time at which the agent was created.
`String`	`getCustomerEncryptionKeyArn()` The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
`String`	`getDescription()` The description of the agent.
`List<String>`	`getFailureReasons()` Contains reasons that the agent-related API that you invoked failed.
`String`	`getFoundationModel()` The foundation model used for orchestration by the agent.
`GuardrailConfiguration`	`getGuardrailConfiguration()` Details about the guardrail associated with the agent.
`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 memory configuration for the agent.
`Date`	`getPreparedAt()` The time at which the agent was last prepared.
`PromptOverrideConfiguration`	`getPromptOverrideConfiguration()` Contains configurations to override prompt templates in different parts of an agent sequence.
`List<String>`	`getRecommendedActions()` Contains recommended actions to take for the agent-related API that you invoked to succeed.
`Date`	`getUpdatedAt()` The time at which the agent was last updated.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAgentArn(String agentArn)` The Amazon Resource Name (ARN) of the agent.
`void`	`setAgentId(String agentId)` The unique identifier of the agent.
`void`	`setAgentName(String agentName)` The name of the agent.
`void`	`setAgentResourceRoleArn(String agentResourceRoleArn)` The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
`void`	`setAgentStatus(String agentStatus)` The status of the agent and whether it is ready for use.
`void`	`setAgentVersion(String agentVersion)` The version of the agent.
`void`	`setClientToken(String clientToken)` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`void`	`setCreatedAt(Date createdAt)` The time at which the agent was created.
`void`	`setCustomerEncryptionKeyArn(String customerEncryptionKeyArn)` The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
`void`	`setDescription(String description)` The description of the agent.
`void`	`setFailureReasons(Collection<String> failureReasons)` Contains reasons that the agent-related API that you invoked failed.
`void`	`setFoundationModel(String foundationModel)` The foundation model used for orchestration by the agent.
`void`	`setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)` Details about the guardrail associated with the agent.
`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 memory configuration for the agent.
`void`	`setPreparedAt(Date preparedAt)` The time at which the agent was last prepared.
`void`	`setPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)` Contains configurations to override prompt templates in different parts of an agent sequence.
`void`	`setRecommendedActions(Collection<String> recommendedActions)` Contains recommended actions to take for the agent-related API that you invoked to succeed.
`void`	`setUpdatedAt(Date updatedAt)` The time at which the agent was last updated.
`String`	`toString()` Returns a string representation of this object.
`Agent`	`withAgentArn(String agentArn)` The Amazon Resource Name (ARN) of the agent.
`Agent`	`withAgentId(String agentId)` The unique identifier of the agent.
`Agent`	`withAgentName(String agentName)` The name of the agent.
`Agent`	`withAgentResourceRoleArn(String agentResourceRoleArn)` The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
`Agent`	`withAgentStatus(AgentStatus agentStatus)` The status of the agent and whether it is ready for use.
`Agent`	`withAgentStatus(String agentStatus)` The status of the agent and whether it is ready for use.
`Agent`	`withAgentVersion(String agentVersion)` The version of the agent.
`Agent`	`withClientToken(String clientToken)` A unique, case-sensitive identifier to ensure that the API request completes no more than one time.
`Agent`	`withCreatedAt(Date createdAt)` The time at which the agent was created.
`Agent`	`withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)` The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
`Agent`	`withDescription(String description)` The description of the agent.
`Agent`	`withFailureReasons(Collection<String> failureReasons)` Contains reasons that the agent-related API that you invoked failed.
`Agent`	`withFailureReasons(String... failureReasons)` Contains reasons that the agent-related API that you invoked failed.
`Agent`	`withFoundationModel(String foundationModel)` The foundation model used for orchestration by the agent.
`Agent`	`withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)` Details about the guardrail associated with the agent.
`Agent`	`withIdleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)` The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
`Agent`	`withInstruction(String instruction)` Instructions that tell the agent what it should do and how it should interact with users.
`Agent`	`withMemoryConfiguration(MemoryConfiguration memoryConfiguration)` Contains memory configuration for the agent.
`Agent`	`withPreparedAt(Date preparedAt)` The time at which the agent was last prepared.
`Agent`	`withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)` Contains configurations to override prompt templates in different parts of an agent sequence.
`Agent`	`withRecommendedActions(Collection<String> recommendedActions)` Contains recommended actions to take for the agent-related API that you invoked to succeed.
`Agent`	`withRecommendedActions(String... recommendedActions)` Contains recommended actions to take for the agent-related API that you invoked to succeed.
`Agent`	`withUpdatedAt(Date updatedAt)` The time at which the agent was last updated.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Agent
```
public Agent()
```
- Method Detail
  - setAgentArn
```
public void setAgentArn(String agentArn)
```
    The Amazon Resource Name (ARN) of the agent.
    
    Parameters:
    
    agentArn - The Amazon Resource Name (ARN) of the agent.
  - getAgentArn
```
public String getAgentArn()
```
    The Amazon Resource Name (ARN) of the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the agent.
  - withAgentArn
```
public Agent withAgentArn(String agentArn)
```
    The Amazon Resource Name (ARN) of the agent.
    
    Parameters:
    
    agentArn - The Amazon Resource Name (ARN) of the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentId
```
public void setAgentId(String agentId)
```
    The unique identifier of the agent.
    
    Parameters:
    
    agentId - The unique identifier of the agent.
  - getAgentId
```
public String getAgentId()
```
    The unique identifier of the agent.
    
    Returns:
    
    The unique identifier of the agent.
  - withAgentId
```
public Agent withAgentId(String agentId)
```
    The unique identifier of the agent.
    
    Parameters:
    
    agentId - The unique identifier of the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAgentName
```
public void setAgentName(String agentName)
```
    The name of the agent.
    
    Parameters:
    
    agentName - The name of the agent.
  - getAgentName
```
public String getAgentName()
```
    The name of the agent.
    
    Returns:
    
    The name of the agent.
  - withAgentName
```
public Agent withAgentName(String agentName)
```
    The name of the agent.
    
    Parameters:
    
    agentName - The name of the agent.
    
    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 Agent 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.
  - setAgentStatus
```
public void setAgentStatus(String agentStatus)
```
    The status of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent is being created.
    - PREPARING – The agent is being prepared.
    - PREPARED – The agent is prepared and ready to be invoked.
    - NOT_PREPARED – The agent has been created but not yet prepared.
    - FAILED – The agent API operation failed.
    - UPDATING – The agent is being updated.
    - DELETING – The agent is being deleted.
    Parameters:
    agentStatus - The status of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent is being created.
    
    PREPARING – The agent is being prepared.
    
    PREPARED – The agent is prepared and ready to be invoked.
    
    NOT_PREPARED – The agent has been created but not yet prepared.
    
    FAILED – The agent API operation failed.
    
    UPDATING – The agent is being updated.
    
    DELETING – The agent is being deleted.
    See Also:
    
    AgentStatus
  - getAgentStatus
```
public String getAgentStatus()
```
    The status of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent is being created.
    - PREPARING – The agent is being prepared.
    - PREPARED – The agent is prepared and ready to be invoked.
    - NOT_PREPARED – The agent has been created but not yet prepared.
    - FAILED – The agent API operation failed.
    - UPDATING – The agent is being updated.
    - DELETING – The agent is being deleted.
    Returns:
    The status of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent is being created.
    
    PREPARING – The agent is being prepared.
    
    PREPARED – The agent is prepared and ready to be invoked.
    
    NOT_PREPARED – The agent has been created but not yet prepared.
    
    FAILED – The agent API operation failed.
    
    UPDATING – The agent is being updated.
    
    DELETING – The agent is being deleted.
    See Also:
    
    AgentStatus
  - withAgentStatus
```
public Agent withAgentStatus(String agentStatus)
```
    The status of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent is being created.
    - PREPARING – The agent is being prepared.
    - PREPARED – The agent is prepared and ready to be invoked.
    - NOT_PREPARED – The agent has been created but not yet prepared.
    - FAILED – The agent API operation failed.
    - UPDATING – The agent is being updated.
    - DELETING – The agent is being deleted.
    Parameters:
    agentStatus - The status of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent is being created.
    
    PREPARING – The agent is being prepared.
    
    PREPARED – The agent is prepared and ready to be invoked.
    
    NOT_PREPARED – The agent has been created but not yet prepared.
    
    FAILED – The agent API operation failed.
    
    UPDATING – The agent is being updated.
    
    DELETING – The agent is being deleted.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentStatus
  - withAgentStatus
```
public Agent withAgentStatus(AgentStatus agentStatus)
```
    The status of the agent and whether it is ready for use. The following statuses are possible:
    - CREATING – The agent is being created.
    - PREPARING – The agent is being prepared.
    - PREPARED – The agent is prepared and ready to be invoked.
    - NOT_PREPARED – The agent has been created but not yet prepared.
    - FAILED – The agent API operation failed.
    - UPDATING – The agent is being updated.
    - DELETING – The agent is being deleted.
    Parameters:
    agentStatus - The status of the agent and whether it is ready for use. The following statuses are possible:
    
    CREATING – The agent is being created.
    
    PREPARING – The agent is being prepared.
    
    PREPARED – The agent is prepared and ready to be invoked.
    
    NOT_PREPARED – The agent has been created but not yet prepared.
    
    FAILED – The agent API operation failed.
    
    UPDATING – The agent is being updated.
    
    DELETING – The agent is being deleted.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    AgentStatus
  - setAgentVersion
```
public void setAgentVersion(String agentVersion)
```
    The version of the agent.
    
    Parameters:
    
    agentVersion - The version of the agent.
  - getAgentVersion
```
public String getAgentVersion()
```
    The version of the agent.
    
    Returns:
    
    The version of the agent.
  - withAgentVersion
```
public Agent withAgentVersion(String agentVersion)
```
    The version of the agent.
    
    Parameters:
    
    agentVersion - The version of 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 Agent 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.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The time at which the agent was created.
    
    Parameters:
    
    createdAt - The time at which the agent was created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The time at which the agent was created.
    
    Returns:
    
    The time at which the agent was created.
  - withCreatedAt
```
public Agent withCreatedAt(Date createdAt)
```
    The time at which the agent was created.
    
    Parameters:
    
    createdAt - The time at which the agent was created.
    
    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 that encrypts the agent.
    
    Parameters:
    
    customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  - getCustomerEncryptionKeyArn
```
public String getCustomerEncryptionKeyArn()
```
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
  - withCustomerEncryptionKeyArn
```
public Agent withCustomerEncryptionKeyArn(String customerEncryptionKeyArn)
```
    The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
    
    Parameters:
    
    customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key that encrypts the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDescription
```
public void setDescription(String description)
```
    The description of the agent.
    
    Parameters:
    
    description - The description of the agent.
  - getDescription
```
public String getDescription()
```
    The description of the agent.
    
    Returns:
    
    The description of the agent.
  - withDescription
```
public Agent withDescription(String description)
```
    The description of the agent.
    
    Parameters:
    
    description - The description of the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFailureReasons
```
public List<String> getFailureReasons()
```
    Contains reasons that the agent-related API that you invoked failed.
    
    Returns:
    
    Contains reasons that the agent-related API that you invoked failed.
  - setFailureReasons
```
public void setFailureReasons(Collection<String> failureReasons)
```
    Contains reasons that the agent-related API that you invoked failed.
    
    Parameters:
    
    failureReasons - Contains reasons that the agent-related API that you invoked failed.
  - withFailureReasons
```
public Agent withFailureReasons(String... failureReasons)
```
    Contains reasons that the agent-related API that you invoked failed.
    
    NOTE: This method appends the values to the existing list (if any). Use setFailureReasons(java.util.Collection) or withFailureReasons(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    failureReasons - Contains reasons that the agent-related API that you invoked failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFailureReasons
```
public Agent withFailureReasons(Collection<String> failureReasons)
```
    Contains reasons that the agent-related API that you invoked failed.
    
    Parameters:
    
    failureReasons - Contains reasons that the agent-related API that you invoked failed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFoundationModel
```
public void setFoundationModel(String foundationModel)
```
    The foundation model used for orchestration by the agent.
    
    Parameters:
    
    foundationModel - The foundation model used for orchestration by the agent.
  - getFoundationModel
```
public String getFoundationModel()
```
    The foundation model used for orchestration by the agent.
    
    Returns:
    
    The foundation model used for orchestration by the agent.
  - withFoundationModel
```
public Agent withFoundationModel(String foundationModel)
```
    The foundation model used for orchestration by the agent.
    
    Parameters:
    
    foundationModel - The foundation model used for orchestration by the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGuardrailConfiguration
```
public void setGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
```
    Details about the guardrail associated with the agent.
    
    Parameters:
    
    guardrailConfiguration - Details about the guardrail associated with the agent.
  - getGuardrailConfiguration
```
public GuardrailConfiguration getGuardrailConfiguration()
```
    Details about the guardrail associated with the agent.
    
    Returns:
    
    Details about the guardrail associated with the agent.
  - withGuardrailConfiguration
```
public Agent withGuardrailConfiguration(GuardrailConfiguration guardrailConfiguration)
```
    Details about the guardrail associated with the agent.
    
    Parameters:
    
    guardrailConfiguration - Details about the guardrail associated with the agent.
    
    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 Agent 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 Agent 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 memory configuration for the agent.
    
    Parameters:
    
    memoryConfiguration - Contains memory configuration for the agent.
  - getMemoryConfiguration
```
public MemoryConfiguration getMemoryConfiguration()
```
    Contains memory configuration for the agent.
    
    Returns:
    
    Contains memory configuration for the agent.
  - withMemoryConfiguration
```
public Agent withMemoryConfiguration(MemoryConfiguration memoryConfiguration)
```
    Contains memory configuration for the agent.
    
    Parameters:
    
    memoryConfiguration - Contains memory configuration for the agent.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPreparedAt
```
public void setPreparedAt(Date preparedAt)
```
    The time at which the agent was last prepared.
    
    Parameters:
    
    preparedAt - The time at which the agent was last prepared.
  - getPreparedAt
```
public Date getPreparedAt()
```
    The time at which the agent was last prepared.
    
    Returns:
    
    The time at which the agent was last prepared.
  - withPreparedAt
```
public Agent withPreparedAt(Date preparedAt)
```
    The time at which the agent was last prepared.
    
    Parameters:
    
    preparedAt - The time at which the agent was last prepared.
    
    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 prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
    
    Parameters:
    
    promptOverrideConfiguration - Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
  - getPromptOverrideConfiguration
```
public PromptOverrideConfiguration getPromptOverrideConfiguration()
```
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
    
    Returns:
    
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
  - withPromptOverrideConfiguration
```
public Agent withPromptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)
```
    Contains configurations to override prompt templates in different parts of an agent sequence. For more information, see Advanced prompts.
    
    Parameters:
    
    promptOverrideConfiguration - Contains configurations to override prompt templates 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.
  - getRecommendedActions
```
public List<String> getRecommendedActions()
```
    Contains recommended actions to take for the agent-related API that you invoked to succeed.
    
    Returns:
    
    Contains recommended actions to take for the agent-related API that you invoked to succeed.
  - setRecommendedActions
```
public void setRecommendedActions(Collection<String> recommendedActions)
```
    Contains recommended actions to take for the agent-related API that you invoked to succeed.
    
    Parameters:
    
    recommendedActions - Contains recommended actions to take for the agent-related API that you invoked to succeed.
  - withRecommendedActions
```
public Agent withRecommendedActions(String... recommendedActions)
```
    Contains recommended actions to take for the agent-related API that you invoked to succeed.
    
    NOTE: This method appends the values to the existing list (if any). Use setRecommendedActions(java.util.Collection) or withRecommendedActions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    recommendedActions - Contains recommended actions to take for the agent-related API that you invoked to succeed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withRecommendedActions
```
public Agent withRecommendedActions(Collection<String> recommendedActions)
```
    Contains recommended actions to take for the agent-related API that you invoked to succeed.
    
    Parameters:
    
    recommendedActions - Contains recommended actions to take for the agent-related API that you invoked to succeed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUpdatedAt
```
public void setUpdatedAt(Date updatedAt)
```
    The time at which the agent was last updated.
    
    Parameters:
    
    updatedAt - The time at which the agent was last updated.
  - getUpdatedAt
```
public Date getUpdatedAt()
```
    The time at which the agent was last updated.
    
    Returns:
    
    The time at which the agent was last updated.
  - withUpdatedAt
```
public Agent withUpdatedAt(Date updatedAt)
```
    The time at which the agent was last updated.
    
    Parameters:
    
    updatedAt - The time at which the agent was last updated.
    
    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 Agent clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.780

Class Agent

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Agent

Method Detail

setAgentArn

getAgentArn

withAgentArn

setAgentId

getAgentId

withAgentId

setAgentName

getAgentName

withAgentName

setAgentResourceRoleArn

getAgentResourceRoleArn

withAgentResourceRoleArn

setAgentStatus

getAgentStatus

withAgentStatus

withAgentStatus

setAgentVersion

getAgentVersion

withAgentVersion

setClientToken

getClientToken

withClientToken

setCreatedAt

getCreatedAt

withCreatedAt

setCustomerEncryptionKeyArn

getCustomerEncryptionKeyArn

withCustomerEncryptionKeyArn

setDescription

getDescription

withDescription

getFailureReasons

setFailureReasons

withFailureReasons

withFailureReasons

setFoundationModel

getFoundationModel

withFoundationModel

setGuardrailConfiguration

getGuardrailConfiguration

withGuardrailConfiguration

setIdleSessionTTLInSeconds

getIdleSessionTTLInSeconds

withIdleSessionTTLInSeconds

setInstruction

getInstruction

withInstruction

setMemoryConfiguration

getMemoryConfiguration

withMemoryConfiguration

setPreparedAt

getPreparedAt

withPreparedAt

setPromptOverrideConfiguration

getPromptOverrideConfiguration

withPromptOverrideConfiguration

getRecommendedActions

setRecommendedActions

withRecommendedActions

withRecommendedActions

setUpdatedAt

getUpdatedAt

withUpdatedAt

toString

equals

hashCode

clone

marshall