Class: Aws::ECS::Types::StopTaskRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-ecs/types.rb

Overview

Note:

When making an API call, you may pass StopTaskRequest data as a hash:

{
  cluster: "String",
  task: "String", # required
  reason: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#cluster ⇒ String

The short name or full Amazon Resource Name (ARN) of the cluster that hosts the task to stop. If you do not specify a cluster, the default cluster is assumed.

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
 
# File 'lib/aws-sdk-ecs/types.rb', line 4782

class StopTaskRequest < Struct.new(
  :cluster,
  :task,
  :reason)
  include Aws::Structure
end

#reason ⇒ String

An optional message specified when a task is stopped. For example, if you are using a custom scheduler, you can use this parameter to specify the reason for stopping the task here, and the message appears in subsequent DescribeTasks API operations on this task. Up to 255 characters are allowed in this message.

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
 
# File 'lib/aws-sdk-ecs/types.rb', line 4782

class StopTaskRequest < Struct.new(
  :cluster,
  :task,
  :reason)
  include Aws::Structure
end

#task ⇒ String

The task ID or full ARN entry of the task to stop.

Returns:

  • (String) 


4782
4783
4784
4785
4786
4787
 
# File 'lib/aws-sdk-ecs/types.rb', line 4782

class StopTaskRequest < Struct.new(
  :cluster,
  :task,
  :reason)
  include Aws::Structure
end