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.CloudDirectory.CreateObject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an object in a Directory. Additionally attaches the object to a parent, if a parent reference and LinkName is specified. An object is simply a collection of Facet attributes. You can also use this API call to create a policy object, if the facet from which you create the object is a policy facet.

Synopsis

data CreateObject = CreateObject' {
- linkName :: Maybe Text
- objectAttributeList :: Maybe [AttributeKeyAndValue]
- parentReference :: Maybe ObjectReference
- directoryArn :: Text
- schemaFacets :: [SchemaFacet]
}
newCreateObject :: Text -> CreateObject
createObject_linkName :: Lens' CreateObject (Maybe Text)
createObject_objectAttributeList :: Lens' CreateObject (Maybe [AttributeKeyAndValue])
createObject_parentReference :: Lens' CreateObject (Maybe ObjectReference)
createObject_directoryArn :: Lens' CreateObject Text
createObject_schemaFacets :: Lens' CreateObject [SchemaFacet]
data CreateObjectResponse = CreateObjectResponse' {
- objectIdentifier :: Maybe Text
- httpStatus :: Int
}
newCreateObjectResponse :: Int -> CreateObjectResponse
createObjectResponse_objectIdentifier :: Lens' CreateObjectResponse (Maybe Text)
createObjectResponse_httpStatus :: Lens' CreateObjectResponse Int

Creating a Request

data CreateObject Source #

See: newCreateObject smart constructor.

Constructors

CreateObject'

Fields

linkName :: Maybe Text
The name of link that is used to attach this object to a parent.
objectAttributeList :: Maybe [AttributeKeyAndValue]
The attribute map whose attribute ARN contains the key and attribute value as the map value.
parentReference :: Maybe ObjectReference
If specified, the parent reference to which this object will be attached.
directoryArn :: Text
The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.
schemaFacets :: [SchemaFacet]
A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

Instances

Instances details

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

newCreateObject Source #

Arguments

:: Text	`CreateObject`
-> CreateObject

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

CreateObject, createObject_linkName - The name of link that is used to attach this object to a parent.

CreateObject, createObject_objectAttributeList - The attribute map whose attribute ARN contains the key and attribute value as the map value.

CreateObject, createObject_parentReference - If specified, the parent reference to which this object will be attached.

CreateObject, createObject_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

CreateObject, createObject_schemaFacets - A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

Request Lenses

createObject_linkName :: Lens' CreateObject (Maybe Text) Source #

The name of link that is used to attach this object to a parent.

createObject_objectAttributeList :: Lens' CreateObject (Maybe [AttributeKeyAndValue]) Source #

The attribute map whose attribute ARN contains the key and attribute value as the map value.

createObject_parentReference :: Lens' CreateObject (Maybe ObjectReference) Source #

If specified, the parent reference to which this object will be attached.

createObject_directoryArn :: Lens' CreateObject Text Source #

The Amazon Resource Name (ARN) that is associated with the Directory in which the object will be created. For more information, see arns.

createObject_schemaFacets :: Lens' CreateObject [SchemaFacet] Source #

A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.

Destructuring the Response

data CreateObjectResponse Source #

See: newCreateObjectResponse smart constructor.

Constructors

CreateObjectResponse'
Fields objectIdentifier :: Maybe Text The identifier that is associated with the object. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCreateObjectResponse Source #

Arguments

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

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

CreateObjectResponse, createObjectResponse_objectIdentifier - The identifier that is associated with the object.

$sel:httpStatus:CreateObjectResponse', createObjectResponse_httpStatus - The response's http status code.

Response Lenses

createObjectResponse_objectIdentifier :: Lens' CreateObjectResponse (Maybe Text) Source #

The identifier that is associated with the object.

createObjectResponse_httpStatus :: Lens' CreateObjectResponse Int Source #

The response's http status code.