amazonka-clouddirectory-2.0: Amazon CloudDirectory SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CloudDirectory.CreateFacet

Description

Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.

Synopsis

Creating a Request

data CreateFacet Source #

See: newCreateFacet smart constructor.

Constructors

CreateFacet' 

Fields

  • attributes :: Maybe [FacetAttribute]

    The attributes that are associated with the Facet.

  • facetStyle :: Maybe FacetStyle

    There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

  • objectType :: Maybe ObjectType

    Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

    • Node: Can have multiple children but one parent.
    • Leaf node: Cannot have children but can have multiple parents.
    • Policy: Allows you to store a policy document and policy type. For more information, see Policies.
    • Index: Can be created with the Index API.
  • schemaArn :: Text

    The schema ARN in which the new Facet will be created. For more information, see arns.

  • name :: Text

    The name of the Facet, which is unique for a given schema.

Instances

Instances details
ToJSON CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

toJSON :: CreateFacet -> Value #

toEncoding :: CreateFacet -> Encoding #

toJSONList :: [CreateFacet] -> Value #

toEncodingList :: [CreateFacet] -> Encoding #

ToHeaders CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

toHeaders :: CreateFacet -> [Header] #

ToPath CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

toPath :: CreateFacet -> ByteString #

ToQuery CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

toQuery :: CreateFacet -> QueryString #

AWSRequest CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Associated Types

type AWSResponse CreateFacet #

Methods

request :: (Service -> Service) -> CreateFacet -> Request CreateFacet #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFacet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFacet))) #

Generic CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Associated Types

type Rep CreateFacet :: Type -> Type #

Methods

from :: CreateFacet -> Rep CreateFacet x #

to :: Rep CreateFacet x -> CreateFacet #

Read CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

readsPrec :: Int -> ReadS CreateFacet #

readList :: ReadS [CreateFacet] #

readPrec :: ReadPrec CreateFacet #

readListPrec :: ReadPrec [CreateFacet] #

Show CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

showsPrec :: Int -> CreateFacet -> ShowS #

show :: CreateFacet -> String #

showList :: [CreateFacet] -> ShowS #

NFData CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

rnf :: CreateFacet -> () #

Eq CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

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

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

Hashable CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

hashWithSalt :: Int -> CreateFacet -> Int #

hash :: CreateFacet -> Int #

type AWSResponse CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

type AWSResponse CreateFacet = CreateFacetResponse
type Rep CreateFacet Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

type Rep CreateFacet = D1 ('MetaData "CreateFacet" "Amazonka.CloudDirectory.CreateFacet" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "CreateFacet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [FacetAttribute])) :*: S1 ('MetaSel ('Just "facetStyle") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe FacetStyle))) :*: (S1 ('MetaSel ('Just "objectType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ObjectType)) :*: (S1 ('MetaSel ('Just "schemaArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateFacet Source #

Arguments

:: Text

CreateFacet

-> Text

CreateFacet

-> CreateFacet 

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

CreateFacet, createFacet_attributes - The attributes that are associated with the Facet.

CreateFacet, createFacet_facetStyle - There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

CreateFacet, createFacet_objectType - Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.
  • Leaf node: Cannot have children but can have multiple parents.
  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.
  • Index: Can be created with the Index API.

CreateFacet, createFacet_schemaArn - The schema ARN in which the new Facet will be created. For more information, see arns.

CreateFacet, createFacet_name - The name of the Facet, which is unique for a given schema.

Request Lenses

createFacet_attributes :: Lens' CreateFacet (Maybe [FacetAttribute]) Source #

The attributes that are associated with the Facet.

createFacet_facetStyle :: Lens' CreateFacet (Maybe FacetStyle) Source #

There are two different styles that you can define on any given facet, Static and Dynamic. For static facets, all attributes must be defined in the schema. For dynamic facets, attributes can be defined during data plane operations.

createFacet_objectType :: Lens' CreateFacet (Maybe ObjectType) Source #

Specifies whether a given object created from this facet is of type node, leaf node, policy or index.

  • Node: Can have multiple children but one parent.
  • Leaf node: Cannot have children but can have multiple parents.
  • Policy: Allows you to store a policy document and policy type. For more information, see Policies.
  • Index: Can be created with the Index API.

createFacet_schemaArn :: Lens' CreateFacet Text Source #

The schema ARN in which the new Facet will be created. For more information, see arns.

createFacet_name :: Lens' CreateFacet Text Source #

The name of the Facet, which is unique for a given schema.

Destructuring the Response

data CreateFacetResponse Source #

See: newCreateFacetResponse smart constructor.

Constructors

CreateFacetResponse' 

Fields

Instances

Instances details
Generic CreateFacetResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Associated Types

type Rep CreateFacetResponse :: Type -> Type #

Methods

from :: CreateFacetResponse -> Rep CreateFacetResponse x #

to :: Rep CreateFacetResponse x -> CreateFacetResponse #

Read CreateFacetResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

readsPrec :: Int -> ReadS CreateFacetResponse #

readList :: ReadS [CreateFacetResponse] #

readPrec :: ReadPrec CreateFacetResponse #

readListPrec :: ReadPrec [CreateFacetResponse] #

Show CreateFacetResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

showsPrec :: Int -> CreateFacetResponse -> ShowS #

show :: CreateFacetResponse -> String #

showList :: [CreateFacetResponse] -> ShowS #

NFData CreateFacetResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

rnf :: CreateFacetResponse -> () #

Eq CreateFacetResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

Methods

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

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

type Rep CreateFacetResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.CreateFacet

type Rep CreateFacetResponse = D1 ('MetaData "CreateFacetResponse" "Amazonka.CloudDirectory.CreateFacet" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "CreateFacetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateFacetResponse Source #

Arguments

:: Int

$sel:httpStatus:CreateFacetResponse'

-> CreateFacetResponse 

Create a value of CreateFacetResponse 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:httpStatus:CreateFacetResponse', createFacetResponse_httpStatus - The response's http status code.

Response Lenses

createFacetResponse_httpStatus :: Lens' CreateFacetResponse Int Source #

The response's http status code.