Skip to content

SystemInstanceDescription

Source code in docs_src/capo_iotthingsgraph/types/system_instance_description.py
class SystemInstanceDescription(TypedDict, closed=True):
    summary: NotRequired[
        "capo_iotthingsgraph.types.system_instance_summary.SystemInstanceSummary"
    ]
    """<p>An object that contains summary information about a system instance.</p>"""
    definition: NotRequired[
        "capo_iotthingsgraph.types.definition_document.DefinitionDocument"
    ]
    s3_bucket_name: NotRequired["capo_iotthingsgraph.types.s3_bucket_name.S3BucketName"]
    """<p>The Amazon Simple Storage Service bucket where information about a system instance is stored.</p>"""
    metrics_configuration: NotRequired[
        "capo_iotthingsgraph.types.metrics_configuration.MetricsConfiguration"
    ]
    validated_namespace_version: NotRequired[
        "capo_iotthingsgraph.types.version.Version"
    ]
    """<p>The version of the user's namespace against which the system instance was validated.</p>"""
    validated_dependency_revisions: NotRequired[
        "capo_iotthingsgraph.types.dependency_revisions.DependencyRevisions"
    ]
    """<p>A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.</p>"""
    flow_actions_role_arn: NotRequired["capo_iotthingsgraph.types.role_arn.RoleArn"]
    """<p>The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.</p>"""

definition instance-attribute

definition: NotRequired[DefinitionDocument]

flow_actions_role_arn instance-attribute

flow_actions_role_arn: NotRequired[RoleArn]

The AWS Identity and Access Management (IAM) role that AWS IoT Things Graph assumes during flow execution in a cloud deployment. This role must have read and write permissionss to AWS Lambda and AWS IoT and to any other AWS services that the flow uses.

metrics_configuration instance-attribute

metrics_configuration: NotRequired[MetricsConfiguration]

s3_bucket_name instance-attribute

s3_bucket_name: NotRequired[S3BucketName]

The Amazon Simple Storage Service bucket where information about a system instance is stored.

summary instance-attribute

summary: NotRequired[SystemInstanceSummary]

An object that contains summary information about a system instance.

validated_dependency_revisions instance-attribute

validated_dependency_revisions: NotRequired[DependencyRevisions]

A list of objects that contain all of the IDs and revision numbers of workflows and systems that are used in a system instance.

validated_namespace_version instance-attribute

validated_namespace_version: NotRequired[Version]

The version of the user's namespace against which the system instance was validated.