Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Personalize.CreateSchema

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon Personalize schema from the specified schema string. The schema you create must be in Avro JSON format.

Amazon Personalize recognizes three schema variants. Each schema is associated with a dataset type and has a set of required field and keywords. If you are creating a schema for a dataset in a Domain dataset group, you provide the domain of the Domain dataset group. You specify a schema when you call CreateDataset.

Related APIs

Synopsis

Creating a Request

data CreateSchema Source #

See: newCreateSchema smart constructor.

Constructors

CreateSchema'
Fields domain :: Maybe Domain The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group. name :: Text The name for the schema. schema :: Text A schema in Avro JSON format.

Instances

Instances details

ToJSON CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods toJSON :: CreateSchema -> Value # toEncoding :: CreateSchema -> Encoding # toJSONList :: [CreateSchema] -> Value # toEncodingList :: [CreateSchema] -> Encoding #
ToHeaders CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods toHeaders :: CreateSchema -> [Header] #
ToPath CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods toPath :: CreateSchema -> ByteString #
ToQuery CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods toQuery :: CreateSchema -> QueryString #
AWSRequest CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Associated Types type AWSResponse CreateSchema # Methods request :: (Service -> Service) -> CreateSchema -> Request CreateSchema # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSchema -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSchema))) #
Generic CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Associated Types type Rep CreateSchema :: Type -> Type # Methods from :: CreateSchema -> Rep CreateSchema x # to :: Rep CreateSchema x -> CreateSchema #
Read CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods readsPrec :: Int -> ReadS CreateSchema # readList :: ReadS [CreateSchema] # readPrec :: ReadPrec CreateSchema # readListPrec :: ReadPrec [CreateSchema] #
Show CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods showsPrec :: Int -> CreateSchema -> ShowS # show :: CreateSchema -> String # showList :: [CreateSchema] -> ShowS #
NFData CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods rnf :: CreateSchema -> () #
Eq CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods (==) :: CreateSchema -> CreateSchema -> Bool # (/=) :: CreateSchema -> CreateSchema -> Bool #
Hashable CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods hashWithSalt :: Int -> CreateSchema -> Int # hash :: CreateSchema -> Int #
type AWSResponse CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema type AWSResponse CreateSchema = CreateSchemaResponse
type Rep CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema type Rep CreateSchema = D1 ('MetaData "CreateSchema" "Amazonka.Personalize.CreateSchema" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateSchema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Domain)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateSchema Source #

Arguments

:: Text	`CreateSchema`
-> Text	`CreateSchema`
-> CreateSchema

Create a value of CreateSchema 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:

CreateSchema, createSchema_domain - The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.

CreateSchema, createSchema_name - The name for the schema.

CreateSchema, createSchema_schema - A schema in Avro JSON format.

Request Lenses

createSchema_domain :: Lens' CreateSchema (Maybe Domain) Source #

The domain for the schema. If you are creating a schema for a dataset in a Domain dataset group, specify the domain you chose when you created the Domain dataset group.

createSchema_name :: Lens' CreateSchema Text Source #

The name for the schema.

createSchema_schema :: Lens' CreateSchema Text Source #

A schema in Avro JSON format.

Destructuring the Response

data CreateSchemaResponse Source #

See: newCreateSchemaResponse smart constructor.

Constructors

CreateSchemaResponse'
Fields schemaArn :: Maybe Text The Amazon Resource Name (ARN) of the created schema. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Associated Types type Rep CreateSchemaResponse :: Type -> Type # Methods from :: CreateSchemaResponse -> Rep CreateSchemaResponse x # to :: Rep CreateSchemaResponse x -> CreateSchemaResponse #
Read CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods readsPrec :: Int -> ReadS CreateSchemaResponse # readList :: ReadS [CreateSchemaResponse] # readPrec :: ReadPrec CreateSchemaResponse # readListPrec :: ReadPrec [CreateSchemaResponse] #
Show CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods showsPrec :: Int -> CreateSchemaResponse -> ShowS # show :: CreateSchemaResponse -> String # showList :: [CreateSchemaResponse] -> ShowS #
NFData CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods rnf :: CreateSchemaResponse -> () #
Eq CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods (==) :: CreateSchemaResponse -> CreateSchemaResponse -> Bool # (/=) :: CreateSchemaResponse -> CreateSchemaResponse -> Bool #
type Rep CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema type Rep CreateSchemaResponse = D1 ('MetaData "CreateSchemaResponse" "Amazonka.Personalize.CreateSchema" "amazonka-personalize-2.0-9kdbGNMxU7zEIoXPqEwwTg" 'False) (C1 ('MetaCons "CreateSchemaResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateSchemaResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSchemaResponse'`
-> CreateSchemaResponse

Create a value of CreateSchemaResponse 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:

CreateSchemaResponse, createSchemaResponse_schemaArn - The Amazon Resource Name (ARN) of the created schema.

$sel:httpStatus:CreateSchemaResponse', createSchemaResponse_httpStatus - The response's http status code.

Response Lenses

createSchemaResponse_schemaArn :: Lens' CreateSchemaResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the created schema.

createSchemaResponse_httpStatus :: Lens' CreateSchemaResponse Int Source #

The response's http status code.