AWS ebs documentation change
Summary
Updated documentation structure, added detailed CLI/PowerShell examples, and expanded EC2 Global View usage instructions
Security assessment
Changes focus on improving clarity, adding command examples, and expanding navigation instructions. No security vulnerabilities or security-specific features are mentioned or addressed in the modifications.
Diff
diff --git a/ebs/latest/userguide/ebs-describing-volumes.md b/ebs/latest/userguide/ebs-describing-volumes.md index 498884f18..a8c621cbc 100644 --- a//ebs/latest/userguide/ebs-describing-volumes.md +++ b//ebs/latest/userguide/ebs-describing-volumes.md @@ -13 +13 @@ You can get additional information about your EBS volumes, such as how much disk -###### Topics +###### Contents @@ -28 +28 @@ You can get additional information about your EBS volumes, such as how much disk -You can view information about a volume using one of the following methods. +You can view information about your EBS volumes. @@ -33 +33 @@ Console -###### To view information about a volume using the console +###### To view information about a volume @@ -46 +46 @@ Console -###### To view the EBS volumes that are attached to an instance using the console +###### To view the EBS volumes that are attached to an instance @@ -62 +62,12 @@ Amazon EC2 Global View -You can use Amazon EC2 Global View to view your volumes across all Regions for which your AWS account is enabled. For more information, see [Amazon EC2 Global View](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/global-view.html). +You can use [Amazon EC2 Global View](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/global-view.html) to view your volumes across all Regions for which your AWS account is enabled. + +###### To get a summary of your EBS volumes across all Regions + + 1. Open the Amazon EC2 Global View console at [https://console.aws.amazon.com/ec2globalview/home](https://console.aws.amazon.com/ec2globalview/home). + + 2. On the **Region explorer** tab, under **Summary** , check the resource count for **Volumes** , which includes the number of volumes and the number of Regions. Click the underlined text to see how the volume count is spread across Regions. + + 3. On the **Global search** tab, select the client filter **Resource type = Volume**. You can filter the results further by specifying a Region or a tag. + + + @@ -67 +78,17 @@ AWS CLI -###### To view information about an EBS volume using the AWS CLI +###### To view information about an EBS volume + +Use the [describe-volumes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volumes.html) command. The following example counts the volumes in the current Region. + + + aws ec2 describe-volumes --query "length(Volumes[*])" + +The following example lists the volumes attached to the specified instance. + + + aws ec2 describe-volumes \ + --filters "Name=attachment.instance-id,Values=i-1234567890abcdef0" \ + --query Volumes[*].VolumeId \ + --output text + +The following example describes the specified volume. + @@ -69 +96,35 @@ AWS CLI -Use the [describe-volumes](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/describe-volumes.html) command. + aws ec2 describe-volumes --volume-ids vol-01234567890abcdef + +The following is example output. + + + { + "Volumes": [ + { + "Iops": 3000, + "VolumeType": "gp3", + "MultiAttachEnabled": false, + "Throughput": 125, + "Operator": { + "Managed": false + }, + "VolumeId": "vol-01234567890abcdef", + "Size": 8, + "SnapshotId": "snap-0abcdef1234567890", + "AvailabilityZone": "us-west-2b", + "State": "in-use", + "CreateTime": "2024-05-17T23:23:00.400000+00:00", + "Attachments": [ + { + "DeleteOnTermination": true, + "VolumeId": "vol-01234567890abcdef", + "InstanceId": "i-1234567890abcdef0", + "Device": "/dev/xvda", + "State": "attached", + "AttachTime": "2024-05-17T23:23:00+00:00" + } + ], + "Encrypted": false + } + ] + } @@ -74 +135,20 @@ PowerShell -###### To view information about an EBS volume using the Tools for Windows PowerShell +###### To view information about an EBS volume + +Use the [Get-EC2Volume](https://docs.aws.amazon.com/powershell/latest/reference/items/Get-EC2Volume.html) cmdlet. The following example counts the volumes in the current Region. + + + (Get-EC2Volume).Count + +The following example lists the volumes attached to the specified instance. + + + (Get-EC2Volume ` + -Filters @{Name="attachment.instance-id";Values="i-1234567890abcdef0"}).VolumeId + +The following example describes the specified volume. + + + Get-EC2Volume -VolumeId vol-01234567890abcdef + +The following is example output. + @@ -76 +156,18 @@ PowerShell -Use the [Get-EC2Volume](https://docs.aws.amazon.com/powershell/latest/reference/items/Get-EC2Volume.html) command. + Attachments : {i-1234567890abcdef0} + AvailabilityZone : us-west-2b + CreateTime : 5/17/2024 11:23:00 PM + Encrypted : False + FastRestored : False + Iops : 3000 + KmsKeyId : + MultiAttachEnabled : False + Operator : Amazon.EC2.Model.OperatorResponse + OutpostArn : + Size : 8 + SnapshotId : snap-0abcdef1234567890 + SseType : + State : in-use + Tags : {} + Throughput : 125 + VolumeId : vol-01234567890abcdef + VolumeType : gp3