Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Paws::EC2::DescribeVolUser(Contributed Perl DocumPaws::EC2::DescribeVolumes(3)

NAME
       Paws::EC2::DescribeVolumes - Arguments for method DescribeVolumes on
       Paws::EC2

DESCRIPTION
       This class represents the parameters used for calling the method
       DescribeVolumes on the Amazon Elastic Compute Cloud service. Use	the
       attributes of this class	as arguments to	method DescribeVolumes.

       You shouln't make instances of this class. Each attribute should	be
       used as a named argument	in the call to DescribeVolumes.

       As an example:

	 $service_obj->DescribeVolumes(Att1 => $value1,	Att2 =>	$value2, ...);

       Values for attributes that are native types (Int, String, Float,	etc)
       can passed as-is	(scalar	values). Values	for complex Types (objects)
       can be passed as	a HashRef. The keys and	values of the hashref will be
       used to instance	the underlying object.

ATTRIBUTES
   DryRun => Bool
       Checks whether you have the required permissions	for the	action,
       without actually	making the request, and	provides an error response. If
       you have	the required permissions, the error response is
       "DryRunOperation". Otherwise, it	is "UnauthorizedOperation".

   Filters => ArrayRef[Paws::EC2::Filter]
       One or more filters.

       o   "attachment.attach-time" - The time stamp when the attachment
	   initiated.

       o   "attachment.delete-on-termination" -	Whether	the volume is deleted
	   on instance termination.

       o   "attachment.device" - The device name that is exposed to the
	   instance (for example, "/dev/sda1").

       o   "attachment.instance-id" - The ID of	the instance the volume	is
	   attached to.

       o   "attachment.status" - The attachment	state ("attaching" |
	   "attached" |	"detaching" | "detached").

       o   "availability-zone" - The Availability Zone in which	the volume was
	   created.

       o   "create-time" - The time stamp when the volume was created.

       o   "encrypted" - The encryption	status of the volume.

       o   "size" - The	size of	the volume, in GiB.

       o   "snapshot-id" - The snapshot	from which the volume was created.

       o   "status" - The status of the	volume ("creating" | "available" |
	   "in-use" | "deleting" | "deleted" | "error").

       o   "tag":key=value - The key/value combination of a tag	assigned to
	   the resource.

       o   "tag-key" - The key of a tag	assigned to the	resource. This filter
	   is independent of the "tag-value" filter. For example, if you use
	   both	the filter "tag-key=Purpose" and the filter "tag-value=X", you
	   get any resources assigned both the tag key Purpose (regardless of
	   what	the tag's value	is), and the tag value X (regardless of	what
	   the tag's key is). If you want to list only resources where Purpose
	   is X, see the "tag":key=value filter.

       o   "tag-value" - The value of a	tag assigned to	the resource. This
	   filter is independent of the	"tag-key" filter.

       o   "volume-id" - The volume ID.

       o   "volume-type" - The Amazon EBS volume type. This can	be "gp2" for
	   General Purpose (SSD) volumes, "io1"	for Provisioned	IOPS (SSD)
	   volumes, or "standard" for Magnetic volumes.

   MaxResults => Int
       The maximum number of volume results returned by	"DescribeVolumes" in
       paginated output. When this parameter is	used, "DescribeVolumes"	only
       returns "MaxResults" results in a single	page along with	a "NextToken"
       response	element. The remaining results of the initial request can be
       seen by sending another "DescribeVolumes" request with the returned
       "NextToken" value. This value can be between 5 and 1000;	if
       "MaxResults" is given a value larger than 1000, only 1000 results are
       returned. If this parameter is not used,	then "DescribeVolumes" returns
       all results. You	cannot specify this parameter and the volume IDs
       parameter in the	same request.

   NextToken =>	Str
       The "NextToken" value returned from a previous paginated
       "DescribeVolumes" request where "MaxResults" was	used and the results
       exceeded	the value of that parameter. Pagination	continues from the end
       of the previous results that returned the "NextToken" value. This value
       is "null" when there are	no more	results	to return.

   VolumeIds =>	ArrayRef[Str]
       One or more volume IDs.

SEE ALSO
       This class forms	part of	Paws, documenting arguments for	method
       DescribeVolumes in Paws::EC2

BUGS and CONTRIBUTIONS
       The source code is located here:	https://github.com/pplu/aws-sdk-perl

       Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

perl v5.24.1			  2015-08-06	 Paws::EC2::DescribeVolumes(3)

NAME | DESCRIPTION | ATTRIBUTES | SEE ALSO | BUGS and CONTRIBUTIONS

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Paws::EC2::DescribeVolumes&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help