Class: Aws::EC2::Types::ModifyImageAttributeRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::EC2::Types::ModifyImageAttributeRequest
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-ec2/types.rb
Overview
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
-
#attribute ⇒ String
The name of the attribute to modify.
-
#description ⇒ Types::AttributeValue
A new 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 new launch permission for the AMI.
-
#operation_type ⇒ String
The operation type.
-
#product_codes ⇒ Array<String>
One or more DevPay 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. The valid values are ‘description`, `launchPermission`, and `productCodes`.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 new description for the AMI.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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`.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 new launch permission for the AMI.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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. This parameter can be used only when the ‘Attribute` parameter is `launchPermission`.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 DevPay product codes. After you add a product code to an AMI, it can’t be removed.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 parameter can be used only when the ‘Attribute` parameter is `launchPermission`.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 parameter can be used only when the ‘Attribute` parameter is `launchPermission`.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 parameter can be used only when the ‘Attribute` parameter is `description` or `productCodes`.
25565 25566 25567 25568 25569 25570 25571 25572 25573 25574 25575 25576 25577 |
# File 'lib/aws-sdk-ec2/types.rb', line 25565 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 |