enable_allowed_images_settings¶
Operation¶
enable_allowed_images_settings
¶
enable_allowed_images_settings(request: EnableAllowedImagesSettingsInput | EnableAllowedImagesSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableAllowedImagesSettingsInputDict]) -> EnableAllowedImagesSettingsOutput
Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are accepted:
-
enabled: The image criteria in your Allowed AMIs settings are applied. As a result, only AMIs matching these criteria are discoverable and can be used by your account to launch instances. -
audit-mode: The image criteria in your Allowed AMIs settings are not applied. No restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account.
The purpose of audit-mode is to indicate which AMIs will be affected
when Allowed AMIs is enabled. In audit-mode, each AMI displays
either "ImageAllowed": true or "ImageAllowed": false to indicate
whether the AMI will be discoverable and available to users in the
account when Allowed AMIs is enabled.
Note
The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableAllowedImagesSettingsInput | EnableAllowedImagesSettingsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[EnableAllowedImagesSettingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableAllowedImagesSettingsOutput
|
An instance of |
enable_allowed_images_settings
async
¶
enable_allowed_images_settings(request: EnableAllowedImagesSettingsInput | EnableAllowedImagesSettingsInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[EnableAllowedImagesSettingsInputDict]) -> EnableAllowedImagesSettingsOutput
Enables Allowed AMIs for your account in the specified Amazon Web Services Region. Two values are accepted:
-
enabled: The image criteria in your Allowed AMIs settings are applied. As a result, only AMIs matching these criteria are discoverable and can be used by your account to launch instances. -
audit-mode: The image criteria in your Allowed AMIs settings are not applied. No restrictions are placed on AMI discoverability or usage. Users in your account can launch instances using any public AMI or AMI shared with your account.
The purpose of audit-mode is to indicate which AMIs will be affected
when Allowed AMIs is enabled. In audit-mode, each AMI displays
either "ImageAllowed": true or "ImageAllowed": false to indicate
whether the AMI will be discoverable and available to users in the
account when Allowed AMIs is enabled.
Note
The Allowed AMIs feature does not restrict the AMIs owned by your account. Regardless of the criteria you set, the AMIs created by your account will always be discoverable and usable by users in your account.
For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
EnableAllowedImagesSettingsInput | EnableAllowedImagesSettingsInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[EnableAllowedImagesSettingsInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
EnableAllowedImagesSettingsOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
EnableAllowedImagesSettingsInputDict
¶
Bases: TypedDict
Dictionary form of EnableAllowedImagesSettingsInput.
Attributes¶
allowed_images_settings_state
instance-attribute
¶
Specify enabled to apply the image criteria specified by the Allowed
AMIs settings. Specify audit-mode so that you can check which AMIs
will be allowed or not allowed by the image criteria.
dry_run
instance-attribute
¶
dry_run: bool | None
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.
EnableAllowedImagesSettingsInput
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableAllowedImagesSettingsInput structure.
Attributes¶
allowed_images_settings_state
class-attribute
instance-attribute
¶
allowed_images_settings_state: str | None = ...
Specify enabled to apply the image criteria specified by the Allowed
AMIs settings. Specify audit-mode so that you can check which AMIs
will be allowed or not allowed by the image criteria.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
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.
Output¶
EnableAllowedImagesSettingsOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for EnableAllowedImagesSettingsOutput structure.
Attributes¶
allowed_images_settings_state
class-attribute
instance-attribute
¶
allowed_images_settings_state: str | None = ...
Returns enabled or audit-mode if the request succeeds; otherwise, it
returns an error.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.