Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.ModifyImageAttribute

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description or LaunchPermission.

Images with an Amazon Web Services Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

Synopsis

data ModifyImageAttribute = ModifyImageAttribute' {
- attribute :: Maybe Text
- description :: Maybe AttributeValue
- dryRun :: Maybe Bool
- launchPermission :: Maybe LaunchPermissionModifications
- operationType :: Maybe OperationType
- organizationArns :: Maybe [Text]
- organizationalUnitArns :: Maybe [Text]
- productCodes :: Maybe [Text]
- userGroups :: Maybe [Text]
- userIds :: Maybe [Text]
- value :: Maybe Text
- imageId :: Text
}
newModifyImageAttribute :: Text -> ModifyImageAttribute
modifyImageAttribute_attribute :: Lens' ModifyImageAttribute (Maybe Text)
modifyImageAttribute_description :: Lens' ModifyImageAttribute (Maybe AttributeValue)
modifyImageAttribute_dryRun :: Lens' ModifyImageAttribute (Maybe Bool)
modifyImageAttribute_launchPermission :: Lens' ModifyImageAttribute (Maybe LaunchPermissionModifications)
modifyImageAttribute_operationType :: Lens' ModifyImageAttribute (Maybe OperationType)
modifyImageAttribute_organizationArns :: Lens' ModifyImageAttribute (Maybe [Text])
modifyImageAttribute_organizationalUnitArns :: Lens' ModifyImageAttribute (Maybe [Text])
modifyImageAttribute_productCodes :: Lens' ModifyImageAttribute (Maybe [Text])
modifyImageAttribute_userGroups :: Lens' ModifyImageAttribute (Maybe [Text])
modifyImageAttribute_userIds :: Lens' ModifyImageAttribute (Maybe [Text])
modifyImageAttribute_value :: Lens' ModifyImageAttribute (Maybe Text)
modifyImageAttribute_imageId :: Lens' ModifyImageAttribute Text
data ModifyImageAttributeResponse = ModifyImageAttributeResponse' {
}
newModifyImageAttributeResponse :: ModifyImageAttributeResponse

Creating a Request

data ModifyImageAttribute Source #

Contains the parameters for ModifyImageAttribute.

See: newModifyImageAttribute smart constructor.

Constructors

ModifyImageAttribute'

Fields

attribute :: Maybe Text
The name of the attribute to modify.
Valid values: description | launchPermission
description :: Maybe AttributeValue
A new description for the AMI.
dryRun :: Maybe Bool
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.
launchPermission :: Maybe LaunchPermissionModifications
A new launch permission for the AMI.
operationType :: Maybe OperationType
The operation type. This parameter can be used only when the Attribute parameter is launchPermission.
organizationArns :: Maybe [Text]
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.
organizationalUnitArns :: Maybe [Text]
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.
productCodes :: Maybe [Text]
Not supported.
userGroups :: Maybe [Text]
The user groups. This parameter can be used only when the Attribute parameter is launchPermission.
userIds :: Maybe [Text]
The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.
value :: Maybe Text
The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description.
imageId :: Text
The ID of the AMI.

Instances

Instances details

ToHeaders ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods toHeaders :: ModifyImageAttribute -> [Header] #
ToPath ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods toPath :: ModifyImageAttribute -> ByteString #
ToQuery ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods toQuery :: ModifyImageAttribute -> QueryString #
AWSRequest ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Associated Types type AWSResponse ModifyImageAttribute # Methods request :: (Service -> Service) -> ModifyImageAttribute -> Request ModifyImageAttribute # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ModifyImageAttribute -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ModifyImageAttribute))) #
Generic ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Associated Types type Rep ModifyImageAttribute :: Type -> Type # Methods from :: ModifyImageAttribute -> Rep ModifyImageAttribute x # to :: Rep ModifyImageAttribute x -> ModifyImageAttribute #
Read ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods readsPrec :: Int -> ReadS ModifyImageAttribute # readList :: ReadS [ModifyImageAttribute] # readPrec :: ReadPrec ModifyImageAttribute # readListPrec :: ReadPrec [ModifyImageAttribute] #
Show ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods showsPrec :: Int -> ModifyImageAttribute -> ShowS # show :: ModifyImageAttribute -> String # showList :: [ModifyImageAttribute] -> ShowS #
NFData ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods rnf :: ModifyImageAttribute -> () #
Eq ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods (==) :: ModifyImageAttribute -> ModifyImageAttribute -> Bool # (/=) :: ModifyImageAttribute -> ModifyImageAttribute -> Bool #
Hashable ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods hashWithSalt :: Int -> ModifyImageAttribute -> Int # hash :: ModifyImageAttribute -> Int #
type AWSResponse ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute type AWSResponse ModifyImageAttribute = ModifyImageAttributeResponse
type Rep ModifyImageAttribute Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute type Rep ModifyImageAttribute = D1 ('MetaData "ModifyImageAttribute" "Amazonka.EC2.ModifyImageAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyImageAttribute'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "attribute") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AttributeValue)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "launchPermission") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe LaunchPermissionModifications)) :: (S1 ('MetaSel ('Just "operationType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe OperationType)) :: S1 ('MetaSel ('Just "organizationArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))) :: ((S1 ('MetaSel ('Just "organizationalUnitArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "productCodes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "userGroups") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: (S1 ('MetaSel ('Just "userIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: (S1 ('MetaSel ('Just "value") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "imageId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newModifyImageAttribute Source #

Arguments

:: Text	`ModifyImageAttribute`
-> ModifyImageAttribute

Create a value of ModifyImageAttribute with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:attribute:ModifyImageAttribute', modifyImageAttribute_attribute - The name of the attribute to modify.

Valid values: description | launchPermission

ModifyImageAttribute, modifyImageAttribute_description - A new description for the AMI.

$sel:dryRun:ModifyImageAttribute', modifyImageAttribute_dryRun - 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.

$sel:launchPermission:ModifyImageAttribute', modifyImageAttribute_launchPermission - A new launch permission for the AMI.

$sel:operationType:ModifyImageAttribute', modifyImageAttribute_operationType - The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

$sel:organizationArns:ModifyImageAttribute', modifyImageAttribute_organizationArns - The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission.

$sel:organizationalUnitArns:ModifyImageAttribute', modifyImageAttribute_organizationalUnitArns - The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission.

ModifyImageAttribute, modifyImageAttribute_productCodes - Not supported.

$sel:userGroups:ModifyImageAttribute', modifyImageAttribute_userGroups - The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

$sel:userIds:ModifyImageAttribute', modifyImageAttribute_userIds - The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

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

ModifyImageAttribute, modifyImageAttribute_imageId - The ID of the AMI.

Request Lenses

modifyImageAttribute_attribute :: Lens' ModifyImageAttribute (Maybe Text) Source #

The name of the attribute to modify.

Valid values: description | launchPermission

modifyImageAttribute_description :: Lens' ModifyImageAttribute (Maybe AttributeValue) Source #

A new description for the AMI.

modifyImageAttribute_dryRun :: Lens' ModifyImageAttribute (Maybe Bool) Source #

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.

modifyImageAttribute_launchPermission :: Lens' ModifyImageAttribute (Maybe LaunchPermissionModifications) Source #

A new launch permission for the AMI.

modifyImageAttribute_operationType :: Lens' ModifyImageAttribute (Maybe OperationType) Source #

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

modifyImageAttribute_organizationArns :: Lens' ModifyImageAttribute (Maybe [Text]) Source #

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

modifyImageAttribute_organizationalUnitArns :: Lens' ModifyImageAttribute (Maybe [Text]) Source #

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

modifyImageAttribute_productCodes :: Lens' ModifyImageAttribute (Maybe [Text]) Source #

Not supported.

modifyImageAttribute_userGroups :: Lens' ModifyImageAttribute (Maybe [Text]) Source #

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

modifyImageAttribute_userIds :: Lens' ModifyImageAttribute (Maybe [Text]) Source #

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

modifyImageAttribute_value :: Lens' ModifyImageAttribute (Maybe Text) Source #

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

modifyImageAttribute_imageId :: Lens' ModifyImageAttribute Text Source #

The ID of the AMI.

Destructuring the Response

data ModifyImageAttributeResponse Source #

See: newModifyImageAttributeResponse smart constructor.

Constructors

ModifyImageAttributeResponse'

Instances

Instances details

Generic ModifyImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Associated Types type Rep ModifyImageAttributeResponse :: Type -> Type # Methods from :: ModifyImageAttributeResponse -> Rep ModifyImageAttributeResponse x # to :: Rep ModifyImageAttributeResponse x -> ModifyImageAttributeResponse #
Read ModifyImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods readsPrec :: Int -> ReadS ModifyImageAttributeResponse # readList :: ReadS [ModifyImageAttributeResponse] # readPrec :: ReadPrec ModifyImageAttributeResponse # readListPrec :: ReadPrec [ModifyImageAttributeResponse] #
Show ModifyImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods showsPrec :: Int -> ModifyImageAttributeResponse -> ShowS # show :: ModifyImageAttributeResponse -> String # showList :: [ModifyImageAttributeResponse] -> ShowS #
NFData ModifyImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods rnf :: ModifyImageAttributeResponse -> () #
Eq ModifyImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute Methods (==) :: ModifyImageAttributeResponse -> ModifyImageAttributeResponse -> Bool # (/=) :: ModifyImageAttributeResponse -> ModifyImageAttributeResponse -> Bool #
type Rep ModifyImageAttributeResponse Source #
Instance details Defined in Amazonka.EC2.ModifyImageAttribute type Rep ModifyImageAttributeResponse = D1 ('MetaData "ModifyImageAttributeResponse" "Amazonka.EC2.ModifyImageAttribute" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "ModifyImageAttributeResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newModifyImageAttributeResponse :: ModifyImageAttributeResponse Source #

Create a value of ModifyImageAttributeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.