Amazonka.SageMaker.Types.EdgeOutputConfig

Documentation

data EdgeOutputConfig

The output configuration.

See: newEdgeOutputConfig smart constructor.

Constructors

EdgeOutputConfig'

Fields

• kmsKeyId :: Maybe Text

  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.

• presetDeploymentConfig :: Maybe Text

  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.

• presetDeploymentType :: Maybe EdgePresetDeploymentType

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

• s3OutputLocation :: Text

  The Amazon Simple Storage (S3) bucker URI.

Instances

FromJSON EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

parseJSON :: Value -> Parser EdgeOutputConfig

parseJSONList :: Value -> Parser [EdgeOutputConfig]

ToJSON EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

toJSON :: EdgeOutputConfig -> Value

toEncoding :: EdgeOutputConfig -> Encoding

toJSONList :: [EdgeOutputConfig] -> Value

toEncodingList :: [EdgeOutputConfig] -> Encoding

Generic EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Associated Types

type Rep EdgeOutputConfig :: Type -> Type

Methods

from :: EdgeOutputConfig -> Rep EdgeOutputConfig x

to :: Rep EdgeOutputConfig x -> EdgeOutputConfig

Read EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

readsPrec :: Int -> ReadS EdgeOutputConfig

readList :: ReadS [EdgeOutputConfig]

readPrec :: ReadPrec EdgeOutputConfig

readListPrec :: ReadPrec [EdgeOutputConfig]

Show EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

showsPrec :: Int -> EdgeOutputConfig -> ShowS

show :: EdgeOutputConfig -> String

showList :: [EdgeOutputConfig] -> ShowS

NFData EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

rnf :: EdgeOutputConfig -> ()

Eq EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

(==) :: EdgeOutputConfig -> EdgeOutputConfig -> Bool

(/=) :: EdgeOutputConfig -> EdgeOutputConfig -> Bool

Hashable EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

Methods

hashWithSalt :: Int -> EdgeOutputConfig -> Int

hash :: EdgeOutputConfig -> Int

type Rep EdgeOutputConfig

Defined in Amazonka.SageMaker.Types.EdgeOutputConfig

type Rep EdgeOutputConfig = D1 ('MetaData "EdgeOutputConfig" "Amazonka.SageMaker.Types.EdgeOutputConfig" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "EdgeOutputConfig'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "presetDeploymentConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "presetDeploymentType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EdgePresetDeploymentType)) :*: S1 ('MetaSel ('Just "s3OutputLocation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newEdgeOutputConfig

Arguments

:: Text

$sel:s3OutputLocation:EdgeOutputConfig'

-> EdgeOutputConfig

Create a value of EdgeOutputConfig with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:kmsKeyId:EdgeOutputConfig', edgeOutputConfig_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.

$sel:presetDeploymentConfig:EdgeOutputConfig', edgeOutputConfig_presetDeploymentConfig - 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.

$sel:presetDeploymentType:EdgeOutputConfig', edgeOutputConfig_presetDeploymentType - The deployment type SageMaker Edge Manager will create. Currently only supports Amazon Web Services IoT Greengrass Version 2 components.

$sel:s3OutputLocation:EdgeOutputConfig', edgeOutputConfig_s3OutputLocation - The Amazon Simple Storage (S3) bucker URI.

edgeOutputConfig_kmsKeyId :: Lens' EdgeOutputConfig (Maybe Text)

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.

edgeOutputConfig_presetDeploymentConfig :: Lens' EdgeOutputConfig (Maybe Text)

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.

edgeOutputConfig_presetDeploymentType :: Lens' EdgeOutputConfig (Maybe EdgePresetDeploymentType)

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

edgeOutputConfig_s3OutputLocation :: Lens' EdgeOutputConfig Text

The Amazon Simple Storage (S3) bucker URI.