EC2 / Client / get_allowed_images_settings

get_allowed_images_settings#

EC2.Client.get_allowed_images_settings(**kwargs)#

Gets the current state of the Allowed AMIs setting and the list of Allowed AMIs criteria at the account level in the specified Region.

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.get_allowed_images_settings(
    DryRun=True|False
)
Parameters:

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

{
    'State': 'string',
    'ImageCriteria': [
        {
            'ImageProviders': [
                'string',
            ]
        },
    ],
    'ManagedBy': 'account'|'declarative-policy'
}

Response Structure

  • (dict) –

    • State (string) –

      The current state of the Allowed AMIs setting at the account level in the specified Amazon Web Services Region.

      Possible values:

      • disabled: All AMIs are allowed.

      • audit-mode: All AMIs are allowed, but the ImageAllowed field is set to true if the AMI would be allowed with the current list of criteria if allowed AMIs was enabled.

      • enabled: Only AMIs matching the image criteria are discoverable and available for use.

    • ImageCriteria (list) –

      The list of criteria for images that 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 AMI 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.

          • (string) –

    • ManagedBy (string) –

      The entity that manages the Allowed AMIs settings. Possible values include:

      • account - The Allowed AMIs settings is managed by the account.

      • declarative-policy - The Allowed AMIs settings is managed by a declarative policy and can’t be modified by the account.