Skip to content

Describes the specified attribute of the specified instance

Description

Describes the specified attribute of the specified instance. You can specify only one attribute at a time. Available attributes include SQL license exemption configuration for instances registered with the SQL LE service.

Usage

ec2_describe_instance_attribute(DryRun, InstanceId, Attribute)

Arguments

  • DryRun

    Checks whether you have the required permissions for the operation, 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.

  • InstanceId

    [required] The ID of the instance.

  • Attribute

    [required] The instance attribute.

    Note that the enaSupport attribute is not supported.

Value

A list with the following syntax:

list(
  BlockDeviceMappings = list(
    list(
      DeviceName = "string",
      Ebs = list(
        AttachTime = as.POSIXct(
          "2015-01-01"
        ),
        DeleteOnTermination = TRUE|FALSE,
        Status = "attaching"|"attached"|"detaching"|"detached",
        VolumeId = "string",
        AssociatedResource = "string",
        VolumeOwnerId = "string",
        Operator = list(
          Managed = TRUE|FALSE,
          Principal = "string",
          HiddenByDefault = TRUE|FALSE
        ),
        EbsCardIndex = 123
      )
    )
  ),
  DisableApiTermination = list(
    Value = TRUE|FALSE
  ),
  EnaSupport = list(
    Value = TRUE|FALSE
  ),
  EnclaveOptions = list(
    Enabled = TRUE|FALSE
  ),
  EbsOptimized = list(
    Value = TRUE|FALSE
  ),
  InstanceId = "string",
  InstanceInitiatedShutdownBehavior = list(
    Value = "string"
  ),
  InstanceType = list(
    Value = "string"
  ),
  KernelId = list(
    Value = "string"
  ),
  ProductCodes = list(
    list(
      ProductCodeId = "string",
      ProductCodeType = "devpay"|"marketplace"
    )
  ),
  RamdiskId = list(
    Value = "string"
  ),
  RootDeviceName = list(
    Value = "string"
  ),
  SourceDestCheck = list(
    Value = TRUE|FALSE
  ),
  SriovNetSupport = list(
    Value = "string"
  ),
  UserData = list(
    Value = "string"
  ),
  DisableApiStop = list(
    Value = TRUE|FALSE
  ),
  Groups = list(
    list(
      GroupId = "string",
      GroupName = "string"
    )
  )
)

Request syntax

svc$describe_instance_attribute(
  DryRun = TRUE|FALSE,
  InstanceId = "string",
  Attribute = "instanceType"|"kernel"|"ramdisk"|"userData"|"disableApiTermination"|"instanceInitiatedShutdownBehavior"|"rootDeviceName"|"blockDeviceMapping"|"productCodes"|"sourceDestCheck"|"groupSet"|"ebsOptimized"|"sriovNetSupport"|"enaSupport"|"enclaveOptions"|"disableApiStop"
)

Examples

# This example describes the instance type of the specified instance.
# 
svc$describe_instance_attribute(
  Attribute = "instanceType",
  InstanceId = "i-1234567890abcdef0"
)

# This example describes the `disableApiTermination` attribute of the
# specified instance.
# 
svc$describe_instance_attribute(
  Attribute = "disableApiTermination",
  InstanceId = "i-1234567890abcdef0"
)

# This example describes the `blockDeviceMapping` attribute of the
# specified instance.
# 
svc$describe_instance_attribute(
  Attribute = "blockDeviceMapping",
  InstanceId = "i-1234567890abcdef0"
)