Class: Aws::Batch::Types::DescribeConsumableResourceResponse

Inherits:

Struct

• Object
• Struct
• Aws::Batch::Types::DescribeConsumableResourceResponse

Includes:

Structure

Defined in:

lib/aws-sdk-batch/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #available_quantity ⇒ Integer

  The amount of the consumable resource that is currently available to use.

• #consumable_resource_arn ⇒ String

  The Amazon Resource Name (ARN) of the consumable resource.

• #consumable_resource_name ⇒ String

  The name of the consumable resource.

• #created_at ⇒ Integer

  The Unix timestamp (in milliseconds) for when the consumable resource was created.

• #in_use_quantity ⇒ Integer

  The amount of the consumable resource that is currently in use.

• #resource_type ⇒ String

  Indicates whether the resource is available to be re-used after a job completes.

• #tags ⇒ Hash<String,String>

  The tags that you apply to the consumable resource to help you categorize and organize your resources.

• #total_quantity ⇒ Integer

  The total amount of the consumable resource that is available.

Instance Attribute Details

#available_quantity ⇒ Integer

The amount of the consumable resource that is currently available to use.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#consumable_resource_arn ⇒ String

The Amazon Resource Name (ARN) of the consumable resource.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#consumable_resource_name ⇒ String

The name of the consumable resource.

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Integer

The Unix timestamp (in milliseconds) for when the consumable resource was created.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#in_use_quantity ⇒ Integer

The amount of the consumable resource that is currently in use.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#resource_type ⇒ String

Indicates whether the resource is available to be re-used after a job completes. Can be one of:

• ‘REPLENISHABLE`

• ‘NON_REPLENISHABLE`

Returns:

• (String)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

The tags that you apply to the consumable resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see [Tagging your Batch resources].

[1]: docs.aws.amazon.com/batch/latest/userguide/using-tags.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#total_quantity ⇒ Integer

The total amount of the consumable resource that is available.

Returns:

• (Integer)

# File 'lib/aws-sdk-batch/types.rb', line 2778

class DescribeConsumableResourceResponse < Struct.new(
  :consumable_resource_name,
  :consumable_resource_arn,
  :total_quantity,
  :in_use_quantity,
  :available_quantity,
  :resource_type,
  :created_at,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end