ec2_describe_snapshot_attribute: Describes the specified attribute of the specified snapshot

Description Usage Arguments Value Request syntax Examples

View source: R/ec2_operations.R

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 Elastic Compute Cloud User Guide.

Usage

1
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:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
list(
  CreateVolumePermissions = list(
    list(
      Group = "all",
      UserId = "string"
    )
  ),
  ProductCodes = list(
    list(
      ProductCodeId = "string",
      ProductCodeType = "devpay"|"marketplace"
    )
  ),
  SnapshotId = "string"
)

Request syntax

1
2
3
4
5
svc$describe_snapshot_attribute(
  Attribute = "productCodes"|"createVolumePermission",
  SnapshotId = "string",
  DryRun = TRUE|FALSE
)

Examples

1
2
3
4
5
6
7
8
9
## Not run: 
# 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"
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.