Skip to content

Describes the specified attribute of the specified snapshot

Description

Describes the specified attribute of the specified snapshot. You can specify only one attribute at a time.

For more information about EBS snapshots, see Amazon EBS snapshots in the Amazon EBS User Guide.

Usage

ec2_describe_snapshot_attribute(Attribute, SnapshotId, DryRun)

Arguments

  • Attribute

    [required] The snapshot attribute you would like to view.

  • SnapshotId

    [required] The ID of the EBS snapshot.

  • DryRun

    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.

Value

A list with the following syntax:

list(
  ProductCodes = list(
    list(
      ProductCodeId = "string",
      ProductCodeType = "devpay"|"marketplace"
    )
  ),
  SnapshotId = "string",
  CreateVolumePermissions = list(
    list(
      UserId = "string",
      Group = "all"
    )
  )
)

Request syntax

svc$describe_snapshot_attribute(
  Attribute = "productCodes"|"createVolumePermission",
  SnapshotId = "string",
  DryRun = TRUE|FALSE
)

Examples

# This example describes the `createVolumePermission` attribute on a
# snapshot with the snapshot ID of `snap-066877671789bd71b`.
svc$describe_snapshot_attribute(
  Attribute = "createVolumePermission",
  SnapshotId = "snap-066877671789bd71b"
)