libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudDirectory.CreateSchema

Description

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.
  • Published: Published schemas are immutable and have a version associated with them.
  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.
Synopsis

Creating a Request

data CreateSchema Source #

See: newCreateSchema smart constructor.

Constructors

CreateSchema' 

Fields

  • name :: Text

    The name that is associated with the schema. This is unique to each account and in each region.

Instances

Instances details
Eq CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

(==) :: CreateSchema -> CreateSchema -> Bool #

(/=) :: CreateSchema -> CreateSchema -> Bool #

Read CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

readsPrec :: Int -> ReadS CreateSchema #

readList :: ReadS [CreateSchema] #

readPrec :: ReadPrec CreateSchema #

readListPrec :: ReadPrec [CreateSchema] #

Show CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

showsPrec :: Int -> CreateSchema -> ShowS #

show :: CreateSchema -> String #

showList :: [CreateSchema] -> ShowS #

Generic CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.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.CloudDirectory.CreateSchema

Methods

rnf :: CreateSchema -> () #

Hashable CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

hashWithSalt :: Int -> CreateSchema -> Int #

hash :: CreateSchema -> Int #

ToJSON CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

toJSON :: CreateSchema -> Value #

toEncoding :: CreateSchema -> Encoding #

toJSONList :: [CreateSchema] -> Value #

toEncodingList :: [CreateSchema] -> Encoding #

AWSRequest CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.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.CloudDirectory.CreateSchema

Methods

toHeaders :: CreateSchema -> [Header] #

ToPath CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

toPath :: CreateSchema -> ByteString #

ToQuery CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

toQuery :: CreateSchema -> QueryString #

type Rep CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

type Rep CreateSchema = D1 ('MetaData "CreateSchema" "Amazonka.CloudDirectory.CreateSchema" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "CreateSchema'" 'PrefixI 'True) (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse CreateSchema Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

type AWSResponse CreateSchema = CreateSchemaResponse

newCreateSchema Source #

Arguments

:: Text

$sel:name: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 that is associated with the schema. This is unique to each account and in each region.

Request Lenses

createSchema_name :: Lens' CreateSchema Text Source #

The name that is associated with the schema. This is unique to each account and in each region.

Destructuring the Response

data CreateSchemaResponse Source #

See: newCreateSchemaResponse smart constructor.

Constructors

CreateSchemaResponse' 

Fields

  • schemaArn :: Maybe Text

    The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq CreateSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

(==) :: CreateSchemaResponse -> CreateSchemaResponse -> Bool #

(/=) :: CreateSchemaResponse -> CreateSchemaResponse -> Bool #

Read CreateSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

readsPrec :: Int -> ReadS CreateSchemaResponse #

readList :: ReadS [CreateSchemaResponse] #

readPrec :: ReadPrec CreateSchemaResponse #

readListPrec :: ReadPrec [CreateSchemaResponse] #

Show CreateSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

Methods

showsPrec :: Int -> CreateSchemaResponse -> ShowS #

show :: CreateSchemaResponse -> String #

showList :: [CreateSchemaResponse] -> ShowS #

Generic CreateSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.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.CloudDirectory.CreateSchema

Methods

rnf :: CreateSchemaResponse -> () #

type Rep CreateSchemaResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateSchema

type Rep CreateSchemaResponse = D1 ('MetaData "CreateSchemaResponse" "Amazonka.CloudDirectory.CreateSchema" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" '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) that is associated with the schema. For more information, see arns.

$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) that is associated with the schema. For more information, see arns.

createSchemaResponse_httpStatus :: Lens' CreateSchemaResponse Int Source #

The response's http status code.