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 |
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.
ModifyImageAttribute' | |
|
Instances
newModifyImageAttribute Source #
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.
Instances
newModifyImageAttributeResponse :: ModifyImageAttributeResponse Source #
Create a value of ModifyImageAttributeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.