Skip to content

EdgeOutputConfig

Source code in docs_src/capo_sagemaker/types/edge_output_config.py
class EdgeOutputConfig(TypedDict, closed=True):
    s3_output_location: NotRequired["capo_sagemaker.types.s3_uri.S3Uri"]
    """<p>The Amazon Simple Storage (S3) bucker URI.</p>"""
    kms_key_id: NotRequired["capo_sagemaker.types.kms_key_id.KmsKeyId"]
    """<p>The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.</p>"""
    preset_deployment_type: NotRequired[
        "capo_sagemaker.types.edge_preset_deployment_type.EdgePresetDeploymentType"
    ]
    """<p>The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.</p>"""
    preset_deployment_config: NotRequired["capo_sagemaker.types.string.String"]
    """<p>The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:</p> <ul> <li> <p> <code>ComponentName</code> (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.</p> </li> <li> <p> <code>ComponentDescription</code> (optional) - Description of the component.</p> </li> <li> <p> <code>ComponentVersion</code> (optional) - The version of the component.</p> <note> <p>Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a<i> major.minor.patch</i> number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the <a href="https://semver.org/">semantic version specification</a>.</p> </note> </li> <li> <p> <code>PlatformOS</code> (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.</p> </li> <li> <p> <code>PlatformArchitecture</code> (optional) - The processor architecture for the platform. </p> <p>Supported architectures Windows include: Windows32_x86, Windows64_x64.</p> <p>Supported architectures for Linux include: Linux x86_64, Linux ARMV8.</p> </li> </ul>"""

kms_key_id instance-attribute

kms_key_id: NotRequired[KmsKeyId]

The Amazon Web Services Key Management Service (Amazon Web Services KMS) key that Amazon SageMaker uses to encrypt data on the storage volume after compilation job. If you don't provide a KMS key ID, Amazon SageMaker uses the default KMS key for Amazon S3 for your role's account.

preset_deployment_config instance-attribute

preset_deployment_config: NotRequired[String]

The configuration used to create deployment artifacts. Specify configuration options with a JSON string. The available configuration options for each type are:

  • ComponentName (optional) - Name of the GreenGrass V2 component. If not specified, the default name generated consists of "SagemakerEdgeManager" and the name of your SageMaker Edge Manager packaging job.

  • ComponentDescription (optional) - Description of the component.

  • ComponentVersion (optional) - The version of the component.

    Amazon Web Services IoT Greengrass uses semantic versions for components. Semantic versions follow a major.minor.patch number system. For example, version 1.0.0 represents the first major release for a component. For more information, see the semantic version specification.

  • PlatformOS (optional) - The name of the operating system for the platform. Supported platforms include Windows and Linux.

  • PlatformArchitecture (optional) - The processor architecture for the platform.

    Supported architectures Windows include: Windows32_x86, Windows64_x64.

    Supported architectures for Linux include: Linux x86_64, Linux ARMV8.

preset_deployment_type instance-attribute

preset_deployment_type: NotRequired[EdgePresetDeploymentType]

The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

s3_output_location instance-attribute

s3_output_location: NotRequired[S3Uri]

The Amazon Simple Storage (S3) bucker URI.