EC2 / Client / replace_image_criteria_in_allowed_images_settings

replace_image_criteria_in_allowed_images_settings#

EC2.Client.replace_image_criteria_in_allowed_images_settings(**kwargs)#

Sets or replaces the criteria for Allowed AMIs.

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.

See also: AWS API Documentation

Request Syntax

response = client.replace_image_criteria_in_allowed_images_settings(
    ImageCriteria=[
        {
            'ImageProviders': [
                'string',
            ]
        },
    ],
    DryRun=True|False
)
Parameters:
  • ImageCriteria (list) –

    The list of criteria that are evaluated to determine whether AMIs are discoverable and usable in the account in the specified Amazon Web Services Region.

    • (dict) –

      The list of criteria that are evaluated to determine whch AMIs are discoverable and usable in the account in the specified Amazon Web Services Region. Currently, the only criteria that can be specified are AMI providers.

      Up to 10 imageCriteria objects can be specified, and up to a total of 200 values for all imageProviders. For more information, see JSON configuration for the Allowed AMIs criteria in the Amazon EC2 User Guide.

      • ImageProviders (list) –

        A list of image providers whose AMIs are discoverable and useable in the account. Up to a total of 200 values can be specified.

        Possible values:

        amazon: Allow AMIs created by Amazon Web Services.

        aws-marketplace: Allow AMIs created by verified providers in the Amazon Web Services Marketplace.

        aws-backup-vault: Allow AMIs created by Amazon Web Services Backup.

        12-digit account ID: Allow AMIs created by this account. One or more account IDs can be specified.

        none: Allow AMIs created by your own account only. When none is specified, no other values can be specified.

        • (string) –

  • DryRun (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.

Return type:

dict

Returns:

Response Syntax

{
    'ReturnValue': True|False
}

Response Structure

  • (dict) –

    • ReturnValue (boolean) –

      Returns true if the request succeeds; otherwise, it returns an error.