You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::EC2::Types::ModifyImageAttributeRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb

Overview

Note:

When making an API call, you may pass ModifyImageAttributeRequest data as a hash:

{
  attribute: "String",
  description: "value", # value <Hash,Array,String,Numeric,Boolean,IO,Set,nil>
  image_id: "String", # required
  launch_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
      },
    ],
  },
  operation_type: "add", # accepts add, remove
  product_codes: ["String"],
  user_groups: ["String"],
  user_ids: ["String"],
  value: "String",
  dry_run: false,
}

Contains the parameters for ModifyImageAttribute.

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.

Returns:

  • (String)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#descriptionTypes::AttributeValue

A new description for the AMI.



16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#dry_runBoolean

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.

Returns:

  • (Boolean)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#image_idString

The ID of the AMI.

Returns:

  • (String)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#launch_permissionTypes::LaunchPermissionModifications

A new launch permission for the AMI.



16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#operation_typeString

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (String)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#product_codesArray<String>

One or more DevPay product codes. After you add a product code to an AMI, it can't be removed.

Returns:

  • (Array<String>)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#user_groupsArray<String>

One or more user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#user_idsArray<String>

One or more AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end

#valueString

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.

Returns:

  • (String)


16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16691

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run)
  include Aws::Structure
end