Skip to content

ComponentSummary

Source code in docs_src/capo_imagebuilder/types/component_summary.py
class ComponentSummary(TypedDict, closed=True):
    arn: NotRequired["capo_imagebuilder.types.image_builder_arn.ImageBuilderArn"]
    """<p>The Amazon Resource Name (ARN) of the component.</p>"""
    name: NotRequired["capo_imagebuilder.types.resource_name.ResourceName"]
    """<p>The name of the component.</p>"""
    version: NotRequired["capo_imagebuilder.types.version_number.VersionNumber"]
    """<p>The version of the component.</p>"""
    platform: NotRequired["capo_imagebuilder.types.platform.Platform"]
    """<p>The operating system platform of the component.</p>"""
    supported_os_versions: NotRequired[
        "capo_imagebuilder.types.os_version_list.OsVersionList"
    ]
    """<p>The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.</p>"""
    state: NotRequired["capo_imagebuilder.types.component_state.ComponentState"]
    """<p>Describes the current status of the component.</p>"""
    type: NotRequired["capo_imagebuilder.types.component_type.ComponentType"]
    """<p>The component type specifies whether Image Builder uses the component to build the image or only to test it.</p>"""
    owner: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The owner of the component. The value is your account ID for components that you own, the sharing account's ID for shared components, or <code>Amazon</code>, <code>ThirdParty</code>, or <code>AWSMarketplace</code>.</p>"""
    description: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>The description of the component.</p>"""
    change_description: NotRequired[
        "capo_imagebuilder.types.non_empty_string.NonEmptyString"
    ]
    """<p>The change description for this version of the component.</p>"""
    date_created: NotRequired["capo_imagebuilder.types.date_time.DateTime"]
    """<p>The date that Image Builder created this version of the component.</p>"""
    tags: NotRequired["capo_imagebuilder.types.tag_map.TagMap"]
    """<p>The tags that apply to the component.</p>"""
    publisher: NotRequired["capo_imagebuilder.types.non_empty_string.NonEmptyString"]
    """<p>Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.</p>"""
    obfuscate: "capo_imagebuilder.types.boolean.Boolean"
    """<p>Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.</p>"""

arn instance-attribute

arn: NotRequired[ImageBuilderArn]

The Amazon Resource Name (ARN) of the component.

change_description instance-attribute

change_description: NotRequired[NonEmptyString]

The change description for this version of the component.

date_created instance-attribute

date_created: NotRequired[DateTime]

The date that Image Builder created this version of the component.

description instance-attribute

description: NotRequired[NonEmptyString]

The description of the component.

name instance-attribute

name: NotRequired[ResourceName]

The name of the component.

obfuscate instance-attribute

obfuscate: Boolean

Indicates whether component source is hidden from view in the console, and from component detail results for API, CLI, or SDK operations.

owner instance-attribute

owner: NotRequired[NonEmptyString]

The owner of the component. The value is your account ID for components that you own, the sharing account's ID for shared components, or Amazon, ThirdParty, or AWSMarketplace.

platform instance-attribute

platform: NotRequired[Platform]

The operating system platform of the component.

publisher instance-attribute

publisher: NotRequired[NonEmptyString]

Contains the name of the publisher if this is a third-party component. Otherwise, this property is empty.

state instance-attribute

state: NotRequired[ComponentState]

Describes the current status of the component.

supported_os_versions instance-attribute

supported_os_versions: NotRequired[OsVersionList]

The operating system (OS) version that the component supports. If the OS information is available, Image Builder performs a prefix match against the base image OS version during image recipe creation.

tags instance-attribute

tags: NotRequired[TagMap]

The tags that apply to the component.

type instance-attribute

type: NotRequired[ComponentType]

The component type specifies whether Image Builder uses the component to build the image or only to test it.

version instance-attribute

version: NotRequired[VersionNumber]

The version of the component.