Skip to content

ImageMetadata

Source code in docs_src/capo_ec2/types/image_metadata.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
class ImageMetadata(TypedDict, closed=True):
    image_id: NotRequired["capo_ec2.types.image_id.ImageId"]
    """<p>The ID of the AMI.</p>"""
    name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the AMI.</p>"""
    owner_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Amazon Web Services account that owns the AMI.</p>"""
    state: NotRequired["capo_ec2.types.image_state.ImageState"]
    """<p>The current state of the AMI. If the state is <code>available</code>, the AMI is successfully registered and can be used to launch an instance.</p>"""
    image_owner_alias: NotRequired["capo_ec2.types.string.String"]
    """<p>The alias of the AMI owner.</p> <p>Valid values: <code>amazon</code> | <code>aws-backup-vault</code> | <code>aws-marketplace</code> </p>"""
    creation_date: NotRequired["capo_ec2.types.string.String"]
    """<p>The date and time the AMI was created.</p>"""
    deprecation_time: NotRequired["capo_ec2.types.string.String"]
    """<p>The deprecation date and time of the AMI, in UTC, in the following format: <i>YYYY</i>-<i>MM</i>-<i>DD</i>T<i>HH</i>:<i>MM</i>:<i>SS</i>Z.</p>"""
    image_allowed: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>If <code>true</code>, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If <code>false</code>, the AMI can't be discovered or used in the account.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html">Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs</a> in <i>Amazon EC2 User Guide</i>.</p>"""
    is_public: NotRequired["capo_ec2.types.boolean.Boolean"]
    """<p>Indicates whether the AMI has public launch permissions. A value of <code>true</code> means this AMI has public launch permissions, while <code>false</code> means it has only implicit (AMI owner) or explicit (shared with your account) launch permissions.</p>"""
    image_watermarks: NotRequired[
        "capo_ec2.types.image_watermark_list.ImageWatermarkList"
    ]
    """<p>The watermarks attached to the AMI.</p>"""

creation_date instance-attribute 

creation_date: NotRequired[String]

The date and time the AMI was created.

deprecation_time instance-attribute 

deprecation_time: NotRequired[String]

The deprecation date and time of the AMI, in UTC, in the following format: YYYY-MM-DDTHH:MM:SSZ.

image_allowed instance-attribute 

image_allowed: NotRequired[Boolean]

If true, the AMI satisfies the criteria for Allowed AMIs and can be discovered and used in the account. If false, the AMI can't be discovered or used in the account.

For more information, see Control the discovery and use of AMIs in Amazon EC2 with Allowed AMIs in Amazon EC2 User Guide.

image_id instance-attribute 

image_id: NotRequired[ImageId]

The ID of the AMI.

image_owner_alias instance-attribute 

image_owner_alias: NotRequired[String]

The alias of the AMI owner.

Valid values: amazon | aws-backup-vault | aws-marketplace

image_watermarks instance-attribute 

image_watermarks: NotRequired[ImageWatermarkList]

The watermarks attached to the AMI.

is_public instance-attribute 

is_public: NotRequired[Boolean]

Indicates whether the AMI has public launch permissions. A value of true means this AMI has public launch permissions, while false means it has only implicit (AMI owner) or explicit (shared with your account) launch permissions.

name instance-attribute 

name: NotRequired[String]

The name of the AMI.

owner_id instance-attribute 

owner_id: NotRequired[String]

The ID of the Amazon Web Services account that owns the AMI.

state instance-attribute 

state: NotRequired[ImageState]

The current state of the AMI. If the state is available, the AMI is successfully registered and can be used to launch an instance.