You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::OpsWorks::Types::DescribeVolumesRequest

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

Overview

Note:

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

{
  instance_id: "String",
  stack_id: "String",
  raid_array_id: "String",
  volume_ids: ["String"],
}

Instance Attribute Summary collapse

Instance Attribute Details

#instance_idString

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

Returns:

  • (String)


3489
3490
3491
3492
3493
3494
3495
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3489

class DescribeVolumesRequest < Struct.new(
  :instance_id,
  :stack_id,
  :raid_array_id,
  :volume_ids)
  include Aws::Structure
end

#raid_array_idString

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

Returns:

  • (String)


3489
3490
3491
3492
3493
3494
3495
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3489

class DescribeVolumesRequest < Struct.new(
  :instance_id,
  :stack_id,
  :raid_array_id,
  :volume_ids)
  include Aws::Structure
end

#stack_idString

A stack ID. The action describes the stack's registered Amazon EBS volumes.

Returns:

  • (String)


3489
3490
3491
3492
3493
3494
3495
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3489

class DescribeVolumesRequest < Struct.new(
  :instance_id,
  :stack_id,
  :raid_array_id,
  :volume_ids)
  include Aws::Structure
end

#volume_idsArray<String>

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

Returns:

  • (Array<String>)


3489
3490
3491
3492
3493
3494
3495
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 3489

class DescribeVolumesRequest < Struct.new(
  :instance_id,
  :stack_id,
  :raid_array_id,
  :volume_ids)
  include Aws::Structure
end