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

Inherits:

Struct

• Object
• Struct
• Aws::EC2::Types::ModifyImageAttributeRequest

Includes:

Structure

Defined in:

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.

See Also:

• AWS API Documentation

Instance Attribute Summary

• #attribute ⇒ String

  The name of the attribute to modify.

• #description ⇒ Types::AttributeValue

  A description for the AMI.

• #dry_run ⇒ Boolean

  Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.

• #image_id ⇒ String

  The ID of the AMI.

• #launch_permission ⇒ Types::LaunchPermissionModifications

  A launch permission modification.

• #operation_type ⇒ String

  The operation type.

• #product_codes ⇒ Array<String>

  One or more product codes.

• #user_groups ⇒ Array<String>

  One or more user groups.

• #user_ids ⇒ Array<String>

  One or more AWS account IDs.

• #value ⇒ String

  The value of the attribute being modified.

Instance Attribute Details

#attribute ⇒ String

The name of the attribute to modify.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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

#description ⇒ Types::AttributeValue

A description for the AMI.

Returns:

• (Types::AttributeValue)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_run ⇒ Boolean

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)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_id ⇒ String

The ID of the AMI.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_permission ⇒ Types::LaunchPermissionModifications

A launch permission modification.

Returns:

• (Types::LaunchPermissionModifications)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_type ⇒ String

The operation type.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_codes ⇒ Array<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>)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_groups ⇒ Array<String>

One or more user groups. This is only valid when modifying the ‘launchPermission` attribute.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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_ids ⇒ Array<String>

One or more AWS account IDs. This is only valid when modifying the ‘launchPermission` attribute.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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

#value ⇒ String

The value of the attribute being modified. This is only valid when modifying the ‘description` attribute.

Returns:

• (String)

# File 'lib/aws-sdk-ec2/types.rb', line 16236

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