Class: Aws::Batch::Types::UpdateConsumableResourceRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#client_token ⇒ String

If this parameter is specified and two update requests with identical payloads and clientTokens are received, these requests are considered the same request. Both requests will succeed, but the update will only happen once. A clientToken is valid for 8 hours.

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

Returns:

  • (String) 


10000
10001
10002
10003
10004
10005
10006
10007
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 10000

class UpdateConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :operation,
  :quantity,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#consumable_resource ⇒ String

The name or ARN of the consumable resource to be updated.

Returns:

  • (String) 


10000
10001
10002
10003
10004
10005
10006
10007
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 10000

class UpdateConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :operation,
  :quantity,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#operation ⇒ String

Indicates how the quantity of the consumable resource will be updated. Must be one of:

  • SET

    Sets the quantity of the resource to the value specified by the quantity parameter.

  • ADD

    Increases the quantity of the resource by the value specified by the quantity parameter.

  • REMOVE

    Reduces the quantity of the resource by the value specified by the quantity parameter.

Returns:

  • (String) 


10000
10001
10002
10003
10004
10005
10006
10007
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 10000

class UpdateConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :operation,
  :quantity,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end

#quantity ⇒ Integer

The change in the total quantity of the consumable resource. The operation parameter determines whether the value specified here will be the new total quantity, or the amount by which the total quantity will be increased or reduced. Must be a non-negative value.

Returns:

  • (Integer) 


10000
10001
10002
10003
10004
10005
10006
10007
 
# File 'gems/aws-sdk-batch/lib/aws-sdk-batch/types.rb', line 10000

class UpdateConsumableResourceRequest < Struct.new(
  :consumable_resource,
  :operation,
  :quantity,
  :client_token)
  SENSITIVE = []
  include Aws::Structure
end