[ aws . ec2 ]

replace-image-criteria-in-allowed-images-settings

Description

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

Synopsis

  replace-image-criteria-in-allowed-images-settings
[--image-criteria <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--image-criteria (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.

(structure)

The criteria that are evaluated to determine which AMIs are discoverable and usable in your account for the specified Amazon Web Services Region.

The ImageCriteria can include up to:

• 10 ImageCriterion

Each ImageCriterion can include up to:

• 200 values for ImageProviders
• 50 values for ImageNames
• 50 values for MarketplaceProductCodes

For more information, see How Allowed AMIs works in the Amazon EC2 User Guide .

ImageProviders -> (list)

The image providers whose images are allowed.

Possible values:

• amazon : Allow AMIs created by Amazon or verified providers.
• 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 the specified accounts. 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.

Maximum: 200 values

(string)

MarketplaceProductCodes -> (list)

The Amazon Web Services Marketplace product codes for allowed images.

Length: 1-25 characters

Valid characters: Letters (A–Z, a–z ) and numbers (0–9 )

Maximum: 50 values

(string)

ImageNames -> (list)

The names of allowed images. Names can include wildcards (? and * ).

Length: 1–128 characters. With ? , the minimum is 3 characters.

Valid characters:

• Letters: A–Z, a–z
• Numbers: 0–9
• Special characters: ( ) [ ] . / - ' @ _ * ?
• Spaces

Maximum: 50 values

(string)

DeprecationTimeCondition -> (structure)

The maximum period since deprecation for allowed images.

MaximumDaysSinceDeprecated -> (integer)

The maximum number of days that have elapsed since the image was deprecated. Set to 0 to exclude all deprecated images.

CreationDateCondition -> (structure)

The maximum age for allowed images.

MaximumDaysSinceCreated -> (integer)

The maximum number of days that have elapsed since the image was created. For example, a value of 300 allows images that were created within the last 300 days.

Shorthand Syntax:

ImageProviders=string,string,MarketplaceProductCodes=string,string,ImageNames=string,string,DeprecationTimeCondition={MaximumDaysSinceDeprecated=integer},CreationDateCondition={MaximumDaysSinceCreated=integer} ...

JSON Syntax:

[
  {
    "ImageProviders": ["string", ...],
    "MarketplaceProductCodes": ["string", ...],
    "ImageNames": ["string", ...],
    "DeprecationTimeCondition": {
      "MaximumDaysSinceDeprecated": integer
    },
    "CreationDateCondition": {
      "MaximumDaysSinceCreated": integer
    }
  }
  ...
]

--dry-run | --no-dry-run (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 .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

ReturnValue -> (boolean)

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