Class: Aws::BedrockAgentCore::Types::StopRuntimeSessionRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_runtime_arnString

The ARN of the agent that contains the session that you want to stop.

Returns:

  • (String)


4898
4899
4900
4901
4902
4903
4904
4905
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4898

class StopRuntimeSessionRequest < Struct.new(
  :runtime_session_id,
  :agent_runtime_arn,
  :qualifier,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#client_tokenString

Idempotent token used to identify the request. If you use the same token with multiple requests, the same response is returned. Use ClientToken to prevent the same request from being processed more than once.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


4898
4899
4900
4901
4902
4903
4904
4905
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4898

class StopRuntimeSessionRequest < Struct.new(
  :runtime_session_id,
  :agent_runtime_arn,
  :qualifier,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#qualifierString

Optional qualifier to specify an agent alias, such as prodcode> or dev. If you don't provide a value, the DEFAULT alias is used.

Returns:

  • (String)


4898
4899
4900
4901
4902
4903
4904
4905
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4898

class StopRuntimeSessionRequest < Struct.new(
  :runtime_session_id,
  :agent_runtime_arn,
  :qualifier,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#runtime_session_idString

The ID of the session that you want to stop.

Returns:

  • (String)


4898
4899
4900
4901
4902
4903
4904
4905
# File 'gems/aws-sdk-bedrockagentcore/lib/aws-sdk-bedrockagentcore/types.rb', line 4898

class StopRuntimeSessionRequest < Struct.new(
  :runtime_session_id,
  :agent_runtime_arn,
  :qualifier,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end