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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AgentCollaboration`	`agentCollaboration()`	The agent's collaboration role.
`String`	`agentCollaborationAsString()`	The agent's collaboration role.
`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.
`CustomOrchestration`	`customOrchestration()`	Contains details of the custom orchestration configured for the agent.
`String`	`description()`	A description of the agent.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`foundationModel()`	The identifier for the model that you want to be used for orchestration by the agent you create.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`GuardrailConfiguration`	`guardrailConfiguration()`	The unique Guardrail configuration assigned to the agent when it is created.
`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.
`MemoryConfiguration`	`memoryConfiguration()`	Contains the details of the memory configured for the agent.
`OrchestrationType`	`orchestrationType()`	Specifies the type of orchestration strategy for the agent.
`String`	`orchestrationTypeAsString()`	Specifies the type of orchestration strategy for the agent.
`PromptOverrideConfiguration`	`promptOverrideConfiguration()`	Contains configurations to override prompts in different parts of an agent sequence.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`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.
  - 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.
  - 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.
  - foundationModel
```
public final String foundationModel()
```
    The identifier for the model that you want to be used for orchestration by the agent you create.
    
    The modelId to provide depends on the type of model or throughput that you use:
    
    If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
    
    If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
    
    If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
    
    If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
    Returns:
    
    The identifier for the model that you want to be used for orchestration by the agent you create.
    
    The modelId to provide depends on the type of model or throughput that you use:
    
    If you use a base model, specify the model ID or its ARN. For a list of model IDs for base models, see Amazon Bedrock base model IDs (on-demand throughput) in the Amazon Bedrock User Guide.
    
    If you use an inference profile, specify the inference profile ID or its ARN. For a list of inference profile IDs, see Supported Regions and models for cross-region inference in the Amazon Bedrock User Guide.
    
    If you use a provisioned model, specify the ARN of the Provisioned Throughput. For more information, see Run inference using a Provisioned Throughput in the Amazon Bedrock User Guide.
    
    If you use a custom model, first purchase Provisioned Throughput for it. Then specify the ARN of the resulting provisioned model. For more information, see Use a custom model in Amazon Bedrock in the Amazon Bedrock User Guide.
    
    If you use an imported model, specify the ARN of the imported model. You can get the model ARN from a successful call to CreateModelImportJob or from the Imported models page in the Amazon Bedrock console.
  - description
```
public final String description()
```
    A description of the agent.
    
    Returns:
    
    A description of the agent.
  - orchestrationType
```
public final OrchestrationType orchestrationType()
```
    Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
    
    If the service returns an enum value that is not available in the current SDK version, orchestrationType will return OrchestrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orchestrationTypeAsString().
    
    Returns:
    
    Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
    
    See Also:
    
    OrchestrationType
  - orchestrationTypeAsString
```
public final String orchestrationTypeAsString()
```
    Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
    
    If the service returns an enum value that is not available in the current SDK version, orchestrationType will return OrchestrationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from orchestrationTypeAsString().
    
    Returns:
    
    Specifies the type of orchestration strategy for the agent. This is set to DEFAULT orchestration type, by default.
    
    See Also:
    
    OrchestrationType
  - customOrchestration
```
public final CustomOrchestration customOrchestration()
```
    Contains details of the custom orchestration configured for the agent.
    
    Returns:
    
    Contains details of the custom orchestration configured for the agent.
  - 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.
  - 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.
  - 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.
  - 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.
  - 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.
  - guardrailConfiguration
```
public final GuardrailConfiguration guardrailConfiguration()
```
    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.
  - memoryConfiguration
```
public final MemoryConfiguration memoryConfiguration()
```
    Contains the details of the memory configured for the agent.
    
    Returns:
    
    Contains the details of the memory configured for the agent.
  - agentCollaboration
```
public final AgentCollaboration agentCollaboration()
```
    The agent's collaboration role.
    
    If the service returns an enum value that is not available in the current SDK version, agentCollaboration will return AgentCollaboration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentCollaborationAsString().
    
    Returns:
    
    The agent's collaboration role.
    
    See Also:
    
    AgentCollaboration
  - agentCollaborationAsString
```
public final String agentCollaborationAsString()
```
    The agent's collaboration role.
    
    If the service returns an enum value that is not available in the current SDK version, agentCollaboration will return AgentCollaboration.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from agentCollaborationAsString().
    
    Returns:
    
    The agent's collaboration role.
    
    See Also:
    
    AgentCollaboration
  - 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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class CreateAgentRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

agentName

clientToken

instruction

foundationModel

description

orchestrationType

orchestrationTypeAsString

customOrchestration

idleSessionTTLInSeconds

agentResourceRoleArn

customerEncryptionKeyArn

hasTags

tags

promptOverrideConfiguration

guardrailConfiguration

memoryConfiguration

agentCollaboration

agentCollaborationAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField