Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

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. You specify a schema when you call CreateDataset.

Related APIs

ListSchemas
DescribeSchema
DeleteSchema

Synopsis

Creating a Request

data CreateSchema Source #

See: newCreateSchema smart constructor.

Constructors

CreateSchema'
Fields name :: Text The name for the schema. schema :: Text A schema in Avro JSON format.

Instances

Instances details

Eq CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods (==) :: CreateSchema -> CreateSchema -> Bool # (/=) :: CreateSchema -> CreateSchema -> Bool #
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 #
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 #
NFData CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods rnf :: CreateSchema -> () #
Hashable CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods hashWithSalt :: Int -> CreateSchema -> Int # hash :: CreateSchema -> Int #
ToJSON CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods toJSON :: CreateSchema -> Value # toEncoding :: CreateSchema -> Encoding # toJSONList :: [CreateSchema] -> Value # toEncodingList :: [CreateSchema] -> Encoding #
AWSRequest CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Associated Types type AWSResponse CreateSchema # Methods request :: CreateSchema -> Request CreateSchema # response :: MonadResource m => Logger -> Service -> Proxy CreateSchema -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSchema))) #
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 #
type Rep CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema type Rep CreateSchema = D1 ('MetaData "CreateSchema" "Amazonka.Personalize.CreateSchema" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" 'False) (C1 ('MetaCons "CreateSchema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "schema") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateSchema Source #
Instance details Defined in Amazonka.Personalize.CreateSchema type AWSResponse CreateSchema = CreateSchemaResponse

newCreateSchema Source #

Arguments

:: Text	`$sel:name:CreateSchema'`
-> Text	`$sel:schema: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:

$sel:name:CreateSchema', createSchema_name - The name for the schema.

$sel:schema:CreateSchema', createSchema_schema - A schema in Avro JSON format.

Request Lenses

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

Eq CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods (==) :: CreateSchemaResponse -> CreateSchemaResponse -> Bool # (/=) :: CreateSchemaResponse -> CreateSchemaResponse -> Bool #
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 #
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 #
NFData CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema Methods rnf :: CreateSchemaResponse -> () #
type Rep CreateSchemaResponse Source #
Instance details Defined in Amazonka.Personalize.CreateSchema type Rep CreateSchemaResponse = D1 ('MetaData "CreateSchemaResponse" "Amazonka.Personalize.CreateSchema" "libZSservicesZSamazonka-personalizeZSamazonka-personalize" '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:

$sel:schemaArn: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.