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.

Returns:

  • (String)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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 description for the AMI.



16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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 launch permission modification.



16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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.

Returns:

  • (String)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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 product codes. After you add a product code to an AMI, it can't be removed. This is only valid when modifying the productCodes attribute.

Returns:

  • (Array<String>)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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 is only valid when modifying the launchPermission attribute.

Returns:

  • (Array<String>)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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 is only valid when modifying the launchPermission attribute.

Returns:

  • (Array<String>)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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 is only valid when modifying the description attribute.

Returns:

  • (String)


16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 16197

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