Skip to content

Change

Source code in docs_src/capo_marketplace_catalog/types/change.py
class Change(TypedDict, closed=True):
    change_type: "capo_marketplace_catalog.types.change_type.ChangeType"
    """<p>Change types are single string values that describe your intention for the change. Each change type is unique for each <code>EntityType</code> provided in the change's scope. For more information about change types available for single-AMI products, see <a href="https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products">Working with single-AMI products</a>. Also, for more information about change types available for container-based products, see <a href="https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products">Working with container products</a>.</p>"""
    entity: "capo_marketplace_catalog.types.entity.Entity"
    """<p>The entity to be changed.</p>"""
    entity_tags: NotRequired["capo_marketplace_catalog.types.tag_list.TagList"]
    """<p>The tags associated with the change.</p>"""
    details: NotRequired["capo_marketplace_catalog.types.json.Json"]
    """<p>This object contains details specific to the change type of the requested change. For more information about change types available for single-AMI products, see <a href="https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/ami-products.html#working-with-single-AMI-products">Working with single-AMI products</a>. Also, for more information about change types available for container-based products, see <a href="https://docs.aws.amazon.com/marketplace-catalog/latest/api-reference/container-products.html#working-with-container-products">Working with container products</a>.</p>"""
    details_document: NotRequired[
        "capo_marketplace_catalog.types.json_document_type.JsonDocumentType"
    ]
    """<p>Alternative field that accepts a JSON value instead of a string for <code>ChangeType</code> details. You can use either <code>Details</code> or <code>DetailsDocument</code>, but not both.</p> <p>To download the "DetailsDocument" shapes, see the <a href="https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-python">Python</a> and <a href="https://github.com/awslabs/aws-marketplace-catalog-api-shapes-for-java/tree/main">Java</a> shapes on GitHub.</p>"""
    change_name: NotRequired["capo_marketplace_catalog.types.change_name.ChangeName"]
    """<p>Optional name for the change.</p>"""

change_name instance-attribute

change_name: NotRequired[ChangeName]

Optional name for the change.

change_type instance-attribute

change_type: ChangeType

Change types are single string values that describe your intention for the change. Each change type is unique for each EntityType provided in the change's scope. For more information about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.

details instance-attribute

details: NotRequired[Json]

This object contains details specific to the change type of the requested change. For more information about change types available for single-AMI products, see Working with single-AMI products. Also, for more information about change types available for container-based products, see Working with container products.

details_document instance-attribute

details_document: NotRequired[JsonDocumentType]

Alternative field that accepts a JSON value instead of a string for ChangeType details. You can use either Details or DetailsDocument, but not both.

To download the "DetailsDocument" shapes, see the Python and Java shapes on GitHub.

entity instance-attribute

entity: Entity

The entity to be changed.

entity_tags instance-attribute

entity_tags: NotRequired[TagList]

The tags associated with the change.