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: "ImageId", # required
  launch_permission: {
    add: [
      {
        group: "all", # accepts all
        user_id: "String",
        organization_arn: "String",
        organizational_unit_arn: "String",
      },
    ],
    remove: [
      {
        group: "all", # accepts all
        user_id: "String",
        organization_arn: "String",
        organizational_unit_arn: "String",
      },
    ],
  },
  operation_type: "add", # accepts add, remove
  product_codes: ["String"],
  user_groups: ["String"],
  user_ids: ["String"],
  value: "String",
  dry_run: false,
  organization_arns: ["String"],
  organizational_unit_arns: ["String"],
}

Contains the parameters for ModifyImageAttribute.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#attributeString

The name of the attribute to modify.

Valid values: description | launchPermission

Returns:

  • (String)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#descriptionTypes::AttributeValue

A new description for the AMI.



46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

class ModifyImageAttributeRequest < Struct.new(
  :attribute,
  :description,
  :image_id,
  :launch_permission,
  :operation_type,
  :product_codes,
  :user_groups,
  :user_ids,
  :value,
  :dry_run,
  :organization_arns,
  :organizational_unit_arns)
  SENSITIVE = []
  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)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#image_idString

The ID of the AMI.

Returns:

  • (String)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#launch_permissionTypes::LaunchPermissionModifications

A new launch permission for the AMI.



46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#operation_typeString

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

Returns:

  • (String)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#organization_arnsArray<String>

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#organizational_unit_arnsArray<String>

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#product_codesArray<String>

Not supported.

Returns:

  • (Array<String>)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#user_groupsArray<String>

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#user_idsArray<String>

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Returns:

  • (Array<String>)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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

#valueString

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

Returns:

  • (String)


46340
46341
46342
46343
46344
46345
46346
46347
46348
46349
46350
46351
46352
46353
46354
46355
# File 'gems/aws-sdk-ec2/lib/aws-sdk-ec2/types.rb', line 46340

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