Skip to content

Blueprint

Source code in docs_src/capo_glue/types/blueprint.py
class Blueprint(TypedDict, closed=True):
    name: NotRequired[
        "capo_glue.types.orchestration_name_string.OrchestrationNameString"
    ]
    """<p>The name of the blueprint.</p>"""
    description: NotRequired[
        "capo_glue.types.generic512_char_string.Generic512CharString"
    ]
    """<p>The description of the blueprint.</p>"""
    created_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time the blueprint was registered.</p>"""
    last_modified_on: NotRequired["capo_glue.types.timestamp_value.TimestampValue"]
    """<p>The date and time the blueprint was last modified.</p>"""
    parameter_spec: NotRequired[
        "capo_glue.types.blueprint_parameter_spec.BlueprintParameterSpec"
    ]
    """<p>A JSON string that indicates the list of parameter specifications for the blueprint.</p>"""
    blueprint_location: NotRequired["capo_glue.types.generic_string.GenericString"]
    """<p>Specifies the path in Amazon S3 where the blueprint is published.</p>"""
    blueprint_service_location: NotRequired[
        "capo_glue.types.generic_string.GenericString"
    ]
    """<p>Specifies a path in Amazon S3 where the blueprint is copied when you call <code>CreateBlueprint/UpdateBlueprint</code> to register the blueprint in Glue.</p>"""
    status: NotRequired["capo_glue.types.blueprint_status.BlueprintStatus"]
    """<p>The status of the blueprint registration.</p> <ul> <li> <p>Creating — The blueprint registration is in progress.</p> </li> <li> <p>Active — The blueprint has been successfully registered.</p> </li> <li> <p>Updating — An update to the blueprint registration is in progress.</p> </li> <li> <p>Failed — The blueprint registration failed.</p> </li> </ul>"""
    error_message: NotRequired["capo_glue.types.error_string.ErrorString"]
    """<p>An error message.</p>"""
    last_active_definition: NotRequired[
        "capo_glue.types.last_active_definition.LastActiveDefinition"
    ]
    """<p>When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.</p>"""

blueprint_location instance-attribute

blueprint_location: NotRequired[GenericString]

Specifies the path in Amazon S3 where the blueprint is published.

blueprint_service_location instance-attribute

blueprint_service_location: NotRequired[GenericString]

Specifies a path in Amazon S3 where the blueprint is copied when you call CreateBlueprint/UpdateBlueprint to register the blueprint in Glue.

created_on instance-attribute

created_on: NotRequired[TimestampValue]

The date and time the blueprint was registered.

description instance-attribute

description: NotRequired[Generic512CharString]

The description of the blueprint.

error_message instance-attribute

error_message: NotRequired[ErrorString]

An error message.

last_active_definition instance-attribute

last_active_definition: NotRequired[LastActiveDefinition]

When there are multiple versions of a blueprint and the latest version has some errors, this attribute indicates the last successful blueprint definition that is available with the service.

last_modified_on instance-attribute

last_modified_on: NotRequired[TimestampValue]

The date and time the blueprint was last modified.

name instance-attribute

name: NotRequired[OrchestrationNameString]

The name of the blueprint.

parameter_spec instance-attribute

parameter_spec: NotRequired[BlueprintParameterSpec]

A JSON string that indicates the list of parameter specifications for the blueprint.

status instance-attribute

status: NotRequired[BlueprintStatus]

The status of the blueprint registration.

  • Creating — The blueprint registration is in progress.

  • Active — The blueprint has been successfully registered.

  • Updating — An update to the blueprint registration is in progress.

  • Failed — The blueprint registration failed.