@datafire/amazonaws_clouddirectory
v5.0.0
Published
DataFire integration for Amazon CloudDirectory
Downloads
1
Readme
@datafire/amazonaws_clouddirectory
Client library for Amazon CloudDirectory
Installation and Usage
npm install --save @datafire/amazonaws_clouddirectory
let amazonaws_clouddirectory = require('@datafire/amazonaws_clouddirectory').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_clouddirectory.BatchRead({
"Operations": []
}).then(data => {
console.log(data);
});
Description
Amazon Cloud Directory Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
Actions
BatchRead
amazonaws_clouddirectory.BatchRead({
"Operations": []
}, context)
Input
- input
object
- Operations required BatchReadOperationList
Output
- output BatchReadResponse
BatchWrite
amazonaws_clouddirectory.BatchWrite({
"Operations": []
}, context)
Input
- input
object
- Operations required BatchWriteOperationList
Output
- output BatchWriteResponse
DeleteDirectory
amazonaws_clouddirectory.DeleteDirectory({}, context)
Input
- input
object
Output
- output DeleteDirectoryResponse
CreateDirectory
amazonaws_clouddirectory.CreateDirectory({
"Name": ""
}, context)
Input
- input
object
- Name required DirectoryName
Output
- output CreateDirectoryResponse
DisableDirectory
amazonaws_clouddirectory.DisableDirectory({}, context)
Input
- input
object
Output
- output DisableDirectoryResponse
EnableDirectory
amazonaws_clouddirectory.EnableDirectory({}, context)
Input
- input
object
Output
- output EnableDirectoryResponse
GetDirectory
amazonaws_clouddirectory.GetDirectory({}, context)
Input
- input
object
Output
- output GetDirectoryResponse
ListDirectories
amazonaws_clouddirectory.ListDirectories({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- state DirectoryState
- MaxResults
Output
- output ListDirectoriesResponse
GetFacet
amazonaws_clouddirectory.GetFacet({
"Name": ""
}, context)
Input
- input
object
- Name required FacetName
Output
- output GetFacetResponse
UpdateFacet
amazonaws_clouddirectory.UpdateFacet({
"Name": ""
}, context)
Input
- input
object
- AttributeUpdates FacetAttributeUpdateList
- Name required FacetName
- ObjectType ObjectType
Output
- output UpdateFacetResponse
ListFacetAttributes
amazonaws_clouddirectory.ListFacetAttributes({
"Name": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- Name required FacetName
- NextToken NextToken
- MaxResults
Output
- output ListFacetAttributesResponse
CreateFacet
amazonaws_clouddirectory.CreateFacet({
"Name": "",
"ObjectType": ""
}, context)
Input
- input
object
- Attributes FacetAttributeList
- Name required FacetName
- ObjectType required ObjectType
Output
- output CreateFacetResponse
DeleteFacet
amazonaws_clouddirectory.DeleteFacet({
"Name": ""
}, context)
Input
- input
object
- Name required FacetName
Output
- output DeleteFacetResponse
ListFacetNames
amazonaws_clouddirectory.ListFacetNames({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- MaxResults
Output
- output ListFacetNamesResponse
CreateIndex
amazonaws_clouddirectory.CreateIndex({
"OrderedIndexedAttributeList": [],
"IsUnique": true
}, context)
Input
- input
object
- IsUnique required Bool
- LinkName LinkName
- OrderedIndexedAttributeList required AttributeKeyList
- ParentReference ObjectReference
Output
- output CreateIndexResponse
AttachToIndex
amazonaws_clouddirectory.AttachToIndex({
"IndexReference": {},
"TargetReference": {}
}, context)
Input
- input
object
- IndexReference required ObjectReference
- TargetReference required ObjectReference
Output
- output AttachToIndexResponse
DetachFromIndex
amazonaws_clouddirectory.DetachFromIndex({
"IndexReference": {},
"TargetReference": {}
}, context)
Input
- input
object
- IndexReference required ObjectReference
- TargetReference required ObjectReference
Output
- output DetachFromIndexResponse
ListIndex
amazonaws_clouddirectory.ListIndex({
"IndexReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- IndexReference required ObjectReference
- MaxResults NumberResults
- NextToken NextToken
- RangesOnIndexedValues ObjectAttributeRangeList
- MaxResults
Output
- output ListIndexResponse
CreateObject
amazonaws_clouddirectory.CreateObject({
"SchemaFacets": []
}, context)
Input
- input
object
- LinkName LinkName
- ObjectAttributeList AttributeKeyAndValueList
- ParentReference ObjectReference
- SchemaFacets required SchemaFacetList
Output
- output CreateObjectResponse
AttachObject
amazonaws_clouddirectory.AttachObject({
"ParentReference": {},
"ChildReference": {},
"LinkName": ""
}, context)
Input
- input
object
- ChildReference required ObjectReference
- LinkName required LinkName
- ParentReference required ObjectReference
Output
- output AttachObjectResponse
ListObjectAttributes
amazonaws_clouddirectory.ListObjectAttributes({
"ObjectReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- FacetFilter SchemaFacet
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
- MaxResults
Output
- output ListObjectAttributesResponse
ListObjectChildren
amazonaws_clouddirectory.ListObjectChildren({
"ObjectReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
- MaxResults
Output
- output ListObjectChildrenResponse
DeleteObject
amazonaws_clouddirectory.DeleteObject({
"ObjectReference": {}
}, context)
Input
- input
object
- ObjectReference required ObjectReference
Output
- output DeleteObjectResponse
DetachObject
amazonaws_clouddirectory.DetachObject({
"ParentReference": {},
"LinkName": ""
}, context)
Input
- input
object
- LinkName required LinkName
- ParentReference required ObjectReference
Output
- output DetachObjectResponse
AddFacetToObject
amazonaws_clouddirectory.AddFacetToObject({
"SchemaFacet": {},
"ObjectReference": {}
}, context)
Input
- input
object
- ObjectAttributeList AttributeKeyAndValueList
- ObjectReference required ObjectReference
- SchemaFacet required SchemaFacet
Output
- output AddFacetToObjectResponse
RemoveFacetFromObject
amazonaws_clouddirectory.RemoveFacetFromObject({
"SchemaFacet": {},
"ObjectReference": {}
}, context)
Input
- input
object
- ObjectReference required ObjectReference
- SchemaFacet required SchemaFacet
Output
ListAttachedIndices
amazonaws_clouddirectory.ListAttachedIndices({
"TargetReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- TargetReference required ObjectReference
- MaxResults
Output
- output ListAttachedIndicesResponse
GetObjectInformation
amazonaws_clouddirectory.GetObjectInformation({
"ObjectReference": {}
}, context)
Input
- input
object
- ObjectReference required ObjectReference
Output
- output GetObjectInformationResponse
ListObjectParents
amazonaws_clouddirectory.ListObjectParents({
"ObjectReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
- MaxResults
Output
- output ListObjectParentsResponse
ListObjectParentPaths
amazonaws_clouddirectory.ListObjectParentPaths({
"ObjectReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
- MaxResults
Output
ListObjectPolicies
amazonaws_clouddirectory.ListObjectPolicies({
"ObjectReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
- MaxResults
Output
- output ListObjectPoliciesResponse
UpdateObjectAttributes
amazonaws_clouddirectory.UpdateObjectAttributes({
"ObjectReference": {},
"AttributeUpdates": []
}, context)
Input
- input
object
- AttributeUpdates required ObjectAttributeUpdateList
- ObjectReference required ObjectReference
Output
AttachPolicy
amazonaws_clouddirectory.AttachPolicy({
"PolicyReference": {},
"ObjectReference": {}
}, context)
Input
- input
object
- ObjectReference required ObjectReference
- PolicyReference required ObjectReference
Output
- output AttachPolicyResponse
ListPolicyAttachments
amazonaws_clouddirectory.ListPolicyAttachments({
"PolicyReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- PolicyReference required ObjectReference
- MaxResults
Output
DetachPolicy
amazonaws_clouddirectory.DetachPolicy({
"PolicyReference": {},
"ObjectReference": {}
}, context)
Input
- input
object
- ObjectReference required ObjectReference
- PolicyReference required ObjectReference
Output
- output DetachPolicyResponse
LookupPolicy
amazonaws_clouddirectory.LookupPolicy({
"ObjectReference": {}
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
- MaxResults
Output
- output LookupPolicyResponse
DeleteSchema
amazonaws_clouddirectory.DeleteSchema({}, context)
Input
- input
object
Output
- output DeleteSchemaResponse
ListAppliedSchemaArns
amazonaws_clouddirectory.ListAppliedSchemaArns({
"DirectoryArn": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- DirectoryArn required Arn
- MaxResults NumberResults
- NextToken NextToken
- SchemaArn Arn
- MaxResults
Output
ApplySchema
amazonaws_clouddirectory.ApplySchema({
"PublishedSchemaArn": ""
}, context)
Input
- input
object
- PublishedSchemaArn required Arn
Output
- output ApplySchemaResponse
CreateSchema
amazonaws_clouddirectory.CreateSchema({
"Name": ""
}, context)
Input
- input
object
- Name required SchemaName
Output
- output CreateSchemaResponse
ListDevelopmentSchemaArns
amazonaws_clouddirectory.ListDevelopmentSchemaArns({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- MaxResults
Output
GetAppliedSchemaVersion
amazonaws_clouddirectory.GetAppliedSchemaVersion({
"SchemaArn": ""
}, context)
Input
- input
object
- SchemaArn required Arn
Output
GetSchemaAsJson
amazonaws_clouddirectory.GetSchemaAsJson({}, context)
Input
- input
object
Output
- output GetSchemaAsJsonResponse
PutSchemaFromJson
amazonaws_clouddirectory.PutSchemaFromJson({
"Document": ""
}, context)
Input
- input
object
- Document required SchemaJsonDocument
Output
- output PutSchemaFromJsonResponse
PublishSchema
amazonaws_clouddirectory.PublishSchema({
"Version": ""
}, context)
Input
- input
object
- MinorVersion Version
- Name SchemaName
- Version required Version
Output
- output PublishSchemaResponse
ListPublishedSchemaArns
amazonaws_clouddirectory.ListPublishedSchemaArns({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- SchemaArn Arn
- MaxResults
Output
UpdateSchema
amazonaws_clouddirectory.UpdateSchema({
"Name": ""
}, context)
Input
- input
object
- Name required SchemaName
Output
- output UpdateSchemaResponse
UpgradeAppliedSchema
amazonaws_clouddirectory.UpgradeAppliedSchema({
"PublishedSchemaArn": "",
"DirectoryArn": ""
}, context)
Input
Output
- output UpgradeAppliedSchemaResponse
UpgradePublishedSchema
amazonaws_clouddirectory.UpgradePublishedSchema({
"DevelopmentSchemaArn": "",
"PublishedSchemaArn": "",
"MinorVersion": ""
}, context)
Input
- input
object
Output
ListTagsForResource
amazonaws_clouddirectory.ListTagsForResource({
"ResourceArn": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults TagsNumberResults
- NextToken NextToken
- ResourceArn required Arn
- MaxResults
Output
- output ListTagsForResourceResponse
TagResource
amazonaws_clouddirectory.TagResource({
"ResourceArn": "",
"Tags": []
}, context)
Input
Output
- output TagResourceResponse
UntagResource
amazonaws_clouddirectory.UntagResource({
"ResourceArn": "",
"TagKeys": []
}, context)
Input
- input
object
- ResourceArn required Arn
- TagKeys required TagKeyList
Output
- output UntagResourceResponse
AttachTypedLink
amazonaws_clouddirectory.AttachTypedLink({
"SourceObjectReference": {},
"TargetObjectReference": {},
"TypedLinkFacet": {
"SchemaArn": "",
"TypedLinkName": ""
},
"Attributes": []
}, context)
Input
- input
object
- Attributes required AttributeNameAndValueList
- SourceObjectReference required ObjectReference
- TargetObjectReference required ObjectReference
- TypedLinkFacet required TypedLinkSchemaAndFacetName
Output
- output AttachTypedLinkResponse
DetachTypedLink
amazonaws_clouddirectory.DetachTypedLink({
"TypedLinkSpecifier": {
"TypedLinkFacet": {
"SchemaArn": "",
"TypedLinkName": ""
},
"SourceObjectReference": {},
"TargetObjectReference": {},
"IdentityAttributeValues": []
}
}, context)
Input
- input
object
- TypedLinkSpecifier required TypedLinkSpecifier
Output
Output schema unknown
UpdateTypedLinkFacet
amazonaws_clouddirectory.UpdateTypedLinkFacet({
"Name": "",
"AttributeUpdates": [],
"IdentityAttributeOrder": []
}, context)
Input
- input
object
- AttributeUpdates required TypedLinkFacetAttributeUpdateList
- IdentityAttributeOrder required AttributeNameList
- Name required TypedLinkName
Output
- output UpdateTypedLinkFacetResponse
ListTypedLinkFacetAttributes
amazonaws_clouddirectory.ListTypedLinkFacetAttributes({
"Name": ""
}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- Name required TypedLinkName
- NextToken NextToken
- MaxResults
Output
CreateTypedLinkFacet
amazonaws_clouddirectory.CreateTypedLinkFacet({
"Facet": {
"Name": "",
"Attributes": [],
"IdentityAttributeOrder": []
}
}, context)
Input
- input
object
- Facet required TypedLinkFacet
Output
- output CreateTypedLinkFacetResponse
DeleteTypedLinkFacet
amazonaws_clouddirectory.DeleteTypedLinkFacet({
"Name": ""
}, context)
Input
- input
object
- Name required TypedLinkName
Output
- output DeleteTypedLinkFacetResponse
GetTypedLinkFacetInformation
amazonaws_clouddirectory.GetTypedLinkFacetInformation({
"Name": ""
}, context)
Input
- input
object
- Name required TypedLinkName
Output
ListTypedLinkFacetNames
amazonaws_clouddirectory.ListTypedLinkFacetNames({}, context)
Input
- input
object
- MaxResults
string
- NextToken
string
- MaxResults NumberResults
- NextToken NextToken
- MaxResults
Output
ListIncomingTypedLinks
amazonaws_clouddirectory.ListIncomingTypedLinks({
"ObjectReference": {}
}, context)
Input
- input
object
- ConsistencyLevel ConsistencyLevel
- FilterAttributeRanges TypedLinkAttributeRangeList
- FilterTypedLink TypedLinkSchemaAndFacetName
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
Output
ListOutgoingTypedLinks
amazonaws_clouddirectory.ListOutgoingTypedLinks({
"ObjectReference": {}
}, context)
Input
- input
object
- ConsistencyLevel ConsistencyLevel
- FilterAttributeRanges TypedLinkAttributeRangeList
- FilterTypedLink TypedLinkSchemaAndFacetName
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
Output
Definitions
AccessDeniedException
- AccessDeniedException
object
: Access denied. Check your permissions.- Message ExceptionMessage
AddFacetToObjectRequest
- AddFacetToObjectRequest
object
- ObjectAttributeList AttributeKeyAndValueList
- ObjectReference required ObjectReference
- SchemaFacet required SchemaFacet
AddFacetToObjectResponse
- AddFacetToObjectResponse
object
ApplySchemaRequest
- ApplySchemaRequest
object
- PublishedSchemaArn required Arn
ApplySchemaResponse
Arn
- Arn
string
Arns
- Arns
array
- items Arn
AttachObjectRequest
- AttachObjectRequest
object
- ChildReference required ObjectReference
- LinkName required LinkName
- ParentReference required ObjectReference
AttachObjectResponse
- AttachObjectResponse
object
- AttachedObjectIdentifier ObjectIdentifier
AttachPolicyRequest
- AttachPolicyRequest
object
- ObjectReference required ObjectReference
- PolicyReference required ObjectReference
AttachPolicyResponse
- AttachPolicyResponse
object
AttachToIndexRequest
- AttachToIndexRequest
object
- IndexReference required ObjectReference
- TargetReference required ObjectReference
AttachToIndexResponse
- AttachToIndexResponse
object
- AttachedObjectIdentifier ObjectIdentifier
AttachTypedLinkRequest
- AttachTypedLinkRequest
object
- Attributes required AttributeNameAndValueList
- SourceObjectReference required ObjectReference
- TargetObjectReference required ObjectReference
- TypedLinkFacet required TypedLinkSchemaAndFacetName
AttachTypedLinkResponse
- AttachTypedLinkResponse
object
- TypedLinkSpecifier TypedLinkSpecifier
AttributeKey
- AttributeKey
object
: A unique identifier for an attribute.- FacetName required FacetName
- Name required AttributeName
- SchemaArn required Arn
AttributeKeyAndValue
- AttributeKeyAndValue
object
: The combination of an attribute key and an attribute value.- Key required AttributeKey
- Value required TypedAttributeValue
AttributeKeyAndValueList
- AttributeKeyAndValueList
array
- items AttributeKeyAndValue
AttributeKeyList
- AttributeKeyList
array
- items AttributeKey
AttributeName
- AttributeName
string
AttributeNameAndValue
- AttributeNameAndValue
object
: Identifies the attribute name and value for a typed link.- AttributeName required AttributeName
- Value required TypedAttributeValue
AttributeNameAndValueList
- AttributeNameAndValueList
array
- items AttributeNameAndValue
AttributeNameList
- AttributeNameList
array
- items AttributeName
BatchAddFacetToObject
- BatchAddFacetToObject
object
: Represents the output of a batch add facet to object operation.- ObjectAttributeList required AttributeKeyAndValueList
- ObjectReference required ObjectReference
- SchemaFacet required SchemaFacet
BatchAddFacetToObjectResponse
- BatchAddFacetToObjectResponse
object
: The result of a batch add facet to object operation.
BatchAttachObject
- BatchAttachObject
object
: Represents the output of an AttachObject operation.- ChildReference required ObjectReference
- LinkName required LinkName
- ParentReference required ObjectReference
BatchAttachObjectResponse
- BatchAttachObjectResponse
object
: Represents the output batch AttachObject response operation.- attachedObjectIdentifier ObjectIdentifier
BatchAttachPolicy
- BatchAttachPolicy
object
: Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations.- ObjectReference required ObjectReference
- PolicyReference required ObjectReference
BatchAttachPolicyResponse
- BatchAttachPolicyResponse
object
: Represents the output of an AttachPolicy response operation.
BatchAttachToIndex
- BatchAttachToIndex
object
: Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations.- IndexReference required ObjectReference
- TargetReference required ObjectReference
BatchAttachToIndexResponse
- BatchAttachToIndexResponse
object
: Represents the output of a AttachToIndex response operation.- AttachedObjectIdentifier ObjectIdentifier
BatchAttachTypedLink
- BatchAttachTypedLink
object
: Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations.- Attributes required AttributeNameAndValueList
- SourceObjectReference required ObjectReference
- TargetObjectReference required ObjectReference
- TypedLinkFacet required TypedLinkSchemaAndFacetName
BatchAttachTypedLinkResponse
- BatchAttachTypedLinkResponse
object
: Represents the output of a AttachTypedLink response operation.- TypedLinkSpecifier TypedLinkSpecifier
BatchCreateIndex
- BatchCreateIndex
object
: Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations.- BatchReferenceName BatchReferenceName
- IsUnique required Bool
- LinkName LinkName
- OrderedIndexedAttributeList required AttributeKeyList
- ParentReference ObjectReference
BatchCreateIndexResponse
- BatchCreateIndexResponse
object
: Represents the output of a CreateIndex response operation.- ObjectIdentifier ObjectIdentifier
BatchCreateObject
- BatchCreateObject
object
: Represents the output of a CreateObject operation.- BatchReferenceName required BatchReferenceName
- LinkName required LinkName
- ObjectAttributeList required AttributeKeyAndValueList
- ParentReference required ObjectReference
- SchemaFacet required SchemaFacetList
BatchCreateObjectResponse
- BatchCreateObjectResponse
object
: Represents the output of a CreateObject response operation.- ObjectIdentifier ObjectIdentifier
BatchDeleteObject
- BatchDeleteObject
object
: Represents the output of a DeleteObject operation.- ObjectReference required ObjectReference
BatchDeleteObjectResponse
- BatchDeleteObjectResponse
object
: Represents the output of a DeleteObject response operation.
BatchDetachFromIndex
- BatchDetachFromIndex
object
: Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations.- IndexReference required ObjectReference
- TargetReference required ObjectReference
BatchDetachFromIndexResponse
- BatchDetachFromIndexResponse
object
: Represents the output of a DetachFromIndex response operation.- DetachedObjectIdentifier ObjectIdentifier
BatchDetachObject
- BatchDetachObject
object
: Represents the output of a DetachObject operation.- BatchReferenceName required BatchReferenceName
- LinkName required LinkName
- ParentReference required ObjectReference
BatchDetachObjectResponse
- BatchDetachObjectResponse
object
: Represents the output of a DetachObject response operation.- detachedObjectIdentifier ObjectIdentifier
BatchDetachPolicy
- BatchDetachPolicy
object
: Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations.- ObjectReference required ObjectReference
- PolicyReference required ObjectReference
BatchDetachPolicyResponse
- BatchDetachPolicyResponse
object
: Represents the output of a DetachPolicy response operation.
BatchDetachTypedLink
- BatchDetachTypedLink
object
: Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations.- TypedLinkSpecifier required TypedLinkSpecifier
BatchDetachTypedLinkResponse
- BatchDetachTypedLinkResponse
object
: Represents the output of a DetachTypedLink response operation.
BatchGetObjectInformation
- BatchGetObjectInformation
object
: Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations.- ObjectReference required ObjectReference
BatchGetObjectInformationResponse
- BatchGetObjectInformationResponse
object
: Represents the output of a GetObjectInformation response operation.- ObjectIdentifier ObjectIdentifier
- SchemaFacets SchemaFacetList
BatchListAttachedIndices
- BatchListAttachedIndices
object
: Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations.- MaxResults NumberResults
- NextToken NextToken
- TargetReference required ObjectReference
BatchListAttachedIndicesResponse
- BatchListAttachedIndicesResponse
object
: Represents the output of a ListAttachedIndices response operation.- IndexAttachments IndexAttachmentList
- NextToken NextToken
BatchListIncomingTypedLinks
- BatchListIncomingTypedLinks
object
: Returns a paginated list of all the incoming TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListIncomingTypedLinks and BatchReadRequest$Operations.- FilterAttributeRanges TypedLinkAttributeRangeList
- FilterTypedLink TypedLinkSchemaAndFacetName
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchListIncomingTypedLinksResponse
- BatchListIncomingTypedLinksResponse
object
: Represents the output of a ListIncomingTypedLinks response operation.- LinkSpecifiers TypedLinkSpecifierList
- NextToken NextToken
BatchListIndex
- BatchListIndex
object
: Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations.- IndexReference required ObjectReference
- MaxResults NumberResults
- NextToken NextToken
- RangesOnIndexedValues ObjectAttributeRangeList
BatchListIndexResponse
- BatchListIndexResponse
object
: Represents the output of a ListIndex response operation.- IndexAttachments IndexAttachmentList
- NextToken NextToken
BatchListObjectAttributes
- BatchListObjectAttributes
object
: Represents the output of a ListObjectAttributes operation.- FacetFilter SchemaFacet
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchListObjectAttributesResponse
- BatchListObjectAttributesResponse
object
: Represents the output of a ListObjectAttributes response operation.- Attributes AttributeKeyAndValueList
- NextToken NextToken
BatchListObjectChildren
- BatchListObjectChildren
object
: Represents the output of a ListObjectChildren operation.- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchListObjectChildrenResponse
- BatchListObjectChildrenResponse
object
: Represents the output of a ListObjectChildren response operation.- Children LinkNameToObjectIdentifierMap
- NextToken NextToken
BatchListObjectParentPaths
- BatchListObjectParentPaths
object
: Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects inside a BatchRead operation. For more information, see ListObjectParentPaths and BatchReadRequest$Operations.- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchListObjectParentPathsResponse
- BatchListObjectParentPathsResponse
object
: Represents the output of a ListObjectParentPaths response operation.- NextToken NextToken
- PathToObjectIdentifiersList PathToObjectIdentifiersList
BatchListObjectPolicies
- BatchListObjectPolicies
object
: Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations.- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchListObjectPoliciesResponse
- BatchListObjectPoliciesResponse
object
: Represents the output of a ListObjectPolicies response operation.- AttachedPolicyIds ObjectIdentifierList
- NextToken NextToken
BatchListOutgoingTypedLinks
- BatchListOutgoingTypedLinks
object
: Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.- FilterAttributeRanges TypedLinkAttributeRangeList
- FilterTypedLink TypedLinkSchemaAndFacetName
- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchListOutgoingTypedLinksResponse
- BatchListOutgoingTypedLinksResponse
object
: Represents the output of a ListOutgoingTypedLinks response operation.- NextToken NextToken
- TypedLinkSpecifiers TypedLinkSpecifierList
BatchListPolicyAttachments
- BatchListPolicyAttachments
object
: Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations.- MaxResults NumberResults
- NextToken NextToken
- PolicyReference required ObjectReference
BatchListPolicyAttachmentsResponse
- BatchListPolicyAttachmentsResponse
object
: Represents the output of a ListPolicyAttachments response operation.- NextToken NextToken
- ObjectIdentifiers ObjectIdentifierList
BatchLookupPolicy
- BatchLookupPolicy
object
: Lists all policies from the root of the Directory to the object specified inside a BatchRead operation. For more information, see LookupPolicy and BatchReadRequest$Operations.- MaxResults NumberResults
- NextToken NextToken
- ObjectReference required ObjectReference
BatchLookupPolicyResponse
- BatchLookupPolicyResponse
object
: Represents the output of a LookupPolicy response operation.- NextToken NextToken
- PolicyToPathList PolicyToPathList
BatchOperationIndex
- BatchOperationIndex
integer
BatchReadException
- BatchReadException
object
: The batch read exception structure, which contains the exception type and message.- Message ExceptionMessage
- Type BatchReadExceptionType
BatchReadExceptionType
- BatchReadExceptionType
string
(values: ValidationException, InvalidArnException, ResourceNotFoundException, InvalidNextTokenException, AccessDeniedException, NotNodeException, FacetValidationException, CannotListParentOfRootException, NotIndexException, NotPolicyException, DirectoryNotEnabledException, LimitExceededException, InternalServiceException)
BatchReadOperation
- BatchReadOperation
object
: Represents the output of a BatchRead operation.- GetObjectInformation BatchGetObjectInformation
- ListAttachedIndices BatchListAttachedIndices
- ListIncomingTypedLinks BatchListIncomingTypedLinks
- ListIndex BatchListIndex
- ListObjectAttributes BatchListObjectAttributes
- ListObjectChildren BatchListObjectChildren
- ListObjectParentPaths BatchListObjectParentPaths
- ListObjectPolicies BatchListObjectPolicies
- ListOutgoingTypedLinks BatchListOutgoingTypedLinks
- ListPolicyAttachments BatchListPolicyAttachments
- LookupPolicy BatchLookupPolicy
BatchReadOperationList
- BatchReadOperationList
array
- items BatchReadOperation
BatchReadOperationResponse
- BatchReadOperationResponse
object
: Represents the output of a BatchRead response operation.- ExceptionResponse BatchReadException
- SuccessfulResponse BatchReadSuccessfulResponse
BatchReadOperationResponseList
- BatchReadOperationResponseList
array
BatchReadRequest
- BatchReadRequest
object
- Operations required BatchReadOperationList
BatchReadResponse
- BatchReadResponse
object
- Responses BatchReadOperationResponseList
BatchReadSuccessfulResponse
- BatchReadSuccessfulResponse
object
: Represents the output of a BatchRead success response operation.- GetObjectInformation BatchGetObjectInformationResponse
- ListAttachedIndices BatchListAttachedIndicesResponse
- ListIncomingTypedLinks BatchListIncomingTypedLinksResponse
- ListIndex BatchListIndexResponse
- ListObjectAttributes BatchListObjectAttributesResponse
- ListObjectChildren BatchListObjectChildrenResponse
- ListObjectParentPaths BatchListObjectParentPathsResponse
- ListObjectPolicies BatchListObjectPoliciesResponse
- ListOutgoingTypedLinks BatchListOutgoingTypedLinksResponse
- ListPolicyAttachments BatchListPolicyAttachmentsResponse
- LookupPolicy BatchLookupPolicyResponse
BatchReferenceName
- BatchReferenceName
string
BatchRemoveFacetFromObject
- BatchRemoveFacetFromObject
object
: A batch operation to remove a facet from an object.- ObjectReference required ObjectReference
- SchemaFacet required SchemaFacet
BatchRemoveFacetFromObjectResponse
- BatchRemoveFacetFromObjectResponse
object
: An empty result that represents success.
BatchUpdateObjectAttributes
- BatchUpdateObjectAttributes
object
: Represents the output of a BatchUpdate operation.- AttributeUpdates required ObjectAttributeUpdateList
- ObjectReference required ObjectReference
BatchUpdateObjectAttributesResponse
- BatchUpdateObjectAttributesResponse
object
: Represents the output of a BatchUpdate response operation.- ObjectIdentifier ObjectIdentifier
BatchWriteException
- BatchWriteException
object
: A BatchWrite exception has occurred.- Index BatchOperationIndex
- Message ExceptionMessage
- Type BatchWriteExceptionType
BatchWriteExceptionType
- BatchWriteExceptionType
string
(values: InternalServiceException, ValidationException, InvalidArnException, LinkNameAlreadyInUseException, StillContainsLinksException, FacetValidationException, ObjectNotDetachedException, ResourceNotFoundException, AccessDeniedException, InvalidAttachmentException, NotIndexException, IndexedAttributeMissingException, ObjectAlreadyDetachedException, NotPolicyException, DirectoryNotEnabledException, LimitExceededException, UnsupportedIndexTypeException)
BatchWriteOperation
- BatchWriteOperation
object
: Represents the output of a BatchWrite operation.- AddFacetToObject BatchAddFacetToObject
- AttachObject BatchAttachObject
- AttachPolicy BatchAttachPolicy
- AttachToIndex BatchAttachToIndex
- AttachTypedLink BatchAttachTypedLink
- CreateIndex BatchCreateIndex
- CreateObject BatchCreateObject
- DeleteObject BatchDeleteObject
- DetachFromIndex BatchDetachFromIndex
- DetachObject BatchDetachObject
- DetachPolicy BatchDetachPolicy
- DetachTypedLink BatchDetachTypedLink
- RemoveFacetFromObject BatchRemoveFacetFromObject
- UpdateObjectAttributes BatchUpdateObjectAttributes
BatchWriteOperationList
- BatchWriteOperationList
array
- items BatchWriteOperation
BatchWriteOperationResponse
- BatchWriteOperationResponse
object
: Represents the output of a BatchWrite response operation.- AddFacetToObject BatchAddFacetToObjectResponse
- AttachObject BatchAttachObjectResponse
- AttachPolicy BatchAttachPolicyResponse
- AttachToIndex BatchAttachToIndexResponse
- AttachTypedLink BatchAttachTypedLinkResponse
- CreateIndex BatchCreateIndexResponse
- CreateObject BatchCreateObjectResponse
- DeleteObject BatchDeleteObjectResponse
- DetachFromIndex BatchDetachFromIndexResponse
- DetachObject BatchDetachObjectResponse
- DetachPolicy BatchDetachPolicyResponse
- DetachTypedLink BatchDetachTypedLinkResponse
- RemoveFacetFromObject BatchRemoveFacetFromObjectResponse
- UpdateObjectAttributes BatchUpdateObjectAttributesResponse
BatchWriteOperationResponseList
- BatchWriteOperationResponseList
array
BatchWriteRequest
- BatchWriteRequest
object
- Operations required BatchWriteOperationList
BatchWriteResponse
- BatchWriteResponse
object
- Responses BatchWriteOperationResponseList
BinaryAttributeValue
- BinaryAttributeValue
string
Bool
- Bool
boolean
BooleanAttributeValue
- BooleanAttributeValue
boolean
CannotListParentOfRootException
- CannotListParentOfRootException
object
: Cannot list the parents of a Directory root.- Message ExceptionMessage
ConsistencyLevel
- ConsistencyLevel
string
(values: SERIALIZABLE, EVENTUAL)
CreateDirectoryRequest
- CreateDirectoryRequest
object
- Name required DirectoryName
CreateDirectoryResponse
- CreateDirectoryResponse
object
- AppliedSchemaArn required Arn
- DirectoryArn required DirectoryArn
- Name required DirectoryName
- ObjectIdentifier required ObjectIdentifier
CreateFacetRequest
- CreateFacetRequest
object
- Attributes FacetAttributeList
- Name required FacetName
- ObjectType required ObjectType
CreateFacetResponse
- CreateFacetResponse
object
CreateIndexRequest
- CreateIndexRequest
object
- IsUnique required Bool
- LinkName LinkName
- OrderedIndexedAttributeList required AttributeKeyList
- ParentReference ObjectReference
CreateIndexResponse
- CreateIndexResponse
object
- ObjectIdentifier ObjectIdentifier
CreateObjectRequest
- CreateObjectRequest
object
- LinkName LinkName
- ObjectAttributeList AttributeKeyAndValueList
- ParentReference ObjectReference
- SchemaFacets required SchemaFacetList
CreateObjectResponse
- CreateObjectResponse
object
- ObjectIdentifier ObjectIdentifier
CreateSchemaRequest
- CreateSchemaRequest
object
- Name required SchemaName
CreateSchemaResponse
- CreateSchemaResponse
object
- SchemaArn Arn
CreateTypedLinkFacetRequest
- CreateTypedLinkFacetRequest
object
- Facet required TypedLinkFacet
CreateTypedLinkFacetResponse
- CreateTypedLinkFacetResponse
object
Date
- Date
string
DatetimeAttributeValue
- DatetimeAttributeValue
string
DeleteDirectoryRequest
- DeleteDirectoryRequest
object
DeleteDirectoryResponse
- DeleteDirectoryResponse
object
- DirectoryArn required Arn
DeleteFacetRequest
- DeleteFacetRequest
object
- Name required FacetName
DeleteFacetResponse
- DeleteFacetResponse
object
DeleteObjectRequest
- DeleteObjectRequest
object
- ObjectReference required ObjectReference
DeleteObjectResponse
- DeleteObjectResponse
object
DeleteSchemaRequest
- DeleteSchemaRequest
object
DeleteSchemaResponse
- DeleteSchemaResponse
object
- SchemaArn Arn
DeleteTypedLinkFacetRequest
- DeleteTypedLinkFacetRequest
object
- Name required TypedLinkName
DeleteTypedLinkFacetResponse
- DeleteTypedLinkFacetResponse
object
DetachFromIndexRequest
- DetachFromIndexRequest
object
- IndexReference required ObjectReference
- TargetReference required ObjectReference
DetachFromIndexResponse
- DetachFromIndexResponse
object
- DetachedObjectIdentifier ObjectIdentifier
DetachObjectRequest
- DetachObjectRequest
object
- LinkName required LinkName
- ParentReference required ObjectReference
DetachObjectResponse
- DetachObjectResponse
object
- DetachedObjectIdentifier ObjectIdentifier
DetachPolicyRequest
- DetachPolicyRequest
object
- ObjectReference required ObjectReference
- PolicyReference required ObjectReference
DetachPolicyResponse
- DetachPolicyResponse
object
DetachTypedLinkRequest
- DetachTypedLinkRequest
object
- TypedLinkSpecifier required TypedLinkSpecifier
Directory
- Directory
object
: Directory structure that includes the directory name and directory ARN.- CreationDateTime Date
- DirectoryArn DirectoryArn
- Name DirectoryName
- State DirectoryState
DirectoryAlreadyExistsException
- DirectoryAlreadyExistsException
object
: Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.- Message ExceptionMessage
DirectoryArn
- DirectoryArn
string
DirectoryDeletedException
- DirectoryDeletedException
object
: A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.- Message ExceptionMessage
DirectoryList
- DirectoryList
array
- items Directory
DirectoryName
- DirectoryName
string
DirectoryNotDisabledException
- DirectoryNotDisabledException
object
: An operation can only operate on a disabled directory.- Message ExceptionMessage
DirectoryNotEnabledException
- DirectoryNotEnabledException
object
: An operation can only operate on a directory that is not enabled.- Message ExceptionMessage
DirectoryState
- DirectoryState
string
(values: ENABLED, DISABLED, DELETED)
DisableDirectoryRequest
- DisableDirectoryRequest
object
DisableDirectoryResponse
- DisableDirectoryResponse
object
- DirectoryArn required Arn
EnableDirectoryRequest
- EnableDirectoryRequest
object
EnableDirectoryResponse
- EnableDirectoryResponse
object
- DirectoryArn required Arn
ExceptionMessage
- ExceptionMessage
string
Facet
- Facet
object
: A structure that contains Name, ARN, Attributes, Rules, and ObjectTypes.- Name FacetName
- ObjectType ObjectType
FacetAlreadyExistsException
- FacetAlreadyExistsException
object
: A facet with the same name already exists.- Message ExceptionMessage
FacetAttribute
- FacetAttribute
object
: An attribute that is associated with the Facet.- AttributeDefinition FacetAttributeDefinition
- AttributeReference FacetAttributeReference
- Name required AttributeName
- RequiredBehavior RequiredAttributeBehavior
FacetAttributeDefinition
- FacetAttributeDefinition
object
: A facet attribute definition. See Attribute References for more information.- DefaultValue TypedAttributeValue
- IsImmutable Bool
- Rules RuleMap
- Type required FacetAttributeType
FacetAttributeList
- FacetAttributeList
array
- items FacetAttribute
FacetAttributeReference
- FacetAttributeReference
object
: The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.- TargetAttributeName required AttributeName
- TargetFacetName required FacetName
FacetAttributeType
- FacetAttributeType
string
(values: STRING, BINARY, BOOLEAN, NUMBER, DATETIME)
FacetAttributeUpdate
- FacetAttributeUpdate
object
: A structure that contains information used to update an attribute.- Action UpdateActionType
- Attribute FacetAttribute
FacetAttributeUpdateList
- FacetAttributeUpdateList
array
- items FacetAttributeUpdate
FacetInUseException
- FacetInUseException
object
: Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.- Message ExceptionMessage
FacetName
- FacetName
string
FacetNameList
- FacetNameList
array
- items FacetName
FacetNotFoundException
- FacetNotFoundException
object
: The specified Facet could not be found.- Message ExceptionMessage
FacetValidationException
- FacetValidationException
object
: The Facet that you provided was not well formed or could not be validated with the schema.- Message ExceptionMessage
GetAppliedSchemaVersionRequest
- GetAppliedSchemaVersionRequest
object
- SchemaArn required Arn
GetAppliedSchemaVersionResponse
- GetAppliedSchemaVersionResponse
object
- AppliedSchemaArn Arn
GetDirectoryRequest
- GetDirectoryRequest
object
GetDirectoryResponse
- GetDirectoryResponse
object
- Directory required Directory
GetFacetRequest
- GetFacetRequest
object
- Name required FacetName
GetFacetResponse
- GetFacetResponse
object
- Facet Facet
GetObjectInformationRequest
- GetObjectInformationRequest
object
- ObjectReference required ObjectReference
GetObjectInformationResponse
- GetObjectInformationResponse
object
- ObjectIdentifier ObjectIdentifier
- SchemaFacets SchemaFacetList
GetSchemaAsJsonRequest
- GetSchemaAsJsonRequest
object
GetSchemaAsJsonResponse
- GetSchemaAsJsonResponse
object
- Document SchemaJsonDocument
- Name SchemaName
GetTypedLinkFacetInformationRequest
- GetTypedLinkFacetInformationRequest
object
- Name required TypedLinkName
GetTypedLinkFacetInformationResponse
- GetTypedLinkFacetInformationResponse
object
- IdentityAttributeOrder AttributeNameList
IncompatibleSchemaException
- IncompatibleSchemaException
object
: Indicates a failure occurred while performing a check for backward compatibility between the specified schema and the schema that is currently applied to the directory.- Message ExceptionMessage
IndexAttachment
- IndexAttachment
object
: Represents an index and an attached object.- IndexedAttributes AttributeKeyAndValueList
- ObjectIdentifier ObjectIdentifier
IndexAttachmentList
- IndexAttachmentList
array
- items IndexAttachment
IndexedAttributeMissingException
- IndexedAttributeMissingException
object
: An object has been attempted to be attached to an object that does not have the appropriate attribute value.- Message ExceptionMessage
InternalServiceException
- InternalServiceException
object
: Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any operational issues with the service.- Message ExceptionMessage
InvalidArnException
- InvalidArnException
object
: Indicates that the provided ARN value is not valid.- Message ExceptionMessage
InvalidAttachmentException
- InvalidAttachmentException
object
: Indicates that an attempt to attach an object with the same link name or to apply a schema with the same name has occurred. Rename the link or the schema and then try again.- Message ExceptionMessage
InvalidFacetUpdateException
- InvalidFacetUpdateException
object
: An attempt to modify a Facet resulted in an invalid schema exception.- Message ExceptionMessage
InvalidNextTokenException
- InvalidNextTokenException
object
: Indicates that the NextToken value is not valid.- Message ExceptionMessage
InvalidRuleException
- InvalidRuleException
object
: Occurs when any of the rule parameter keys or values are invalid.- Message ExceptionMessage
InvalidSchemaDocException
- InvalidSchemaDocException
object
: Indicates that the provided SchemaDoc value is not valid.- Message ExceptionMessage
InvalidTaggingRequestException
- InvalidTaggingRequestException
object
: Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.- Message ExceptionMessage
LimitExceededException
- LimitExceededException
object
: Indicates that limits are exceeded. See Limits for more information.- Message ExceptionMessage
LinkName
- LinkName
string
LinkNameAlreadyInUseException
- LinkNameAlreadyInUseException
object
: Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.- Message ExceptionMessage
LinkNameToObjectIdentifierMap
- LinkNameToObjectIdentifierMap
array
- items
object
- key LinkName
- value ObjectIdentifier
- items
ListAppliedSchemaArnsRequest
- ListAppliedSchemaArnsRequest
object
- DirectoryArn required Arn
- MaxResults NumberResults
- NextToken NextToken
- SchemaArn Arn
ListAppliedSchemaArnsResponse
ListAttachedIndicesRequest
- ListAttachedIndicesRequest
object
- MaxResults NumberResults
- NextToken NextToken
- TargetReference required ObjectReference
ListAttachedIndicesResponse
- ListAttachedIndicesResponse
object
- IndexAttachments IndexAttachmentList
- NextToken NextToken
ListDevelopmentSchemaArnsRequest
- ListDevelopmentSchemaArnsRequest
object
- MaxResults NumberResults
- NextToken NextToken
ListDevelopmentSchemaArnsResponse
ListDirectoriesRequest
- ListDirectoriesRequest
object
- MaxResults NumberResults
- NextToken NextToken
- state DirectoryState
ListDirectoriesResponse
- ListDirectoriesResponse
object
- Directories required DirectoryList
- NextToken NextToken
ListFacetAttributesRequest
- ListFacetAttributesRequest
object
- MaxResults NumberResults
- Name required FacetName
- NextToken NextToken
ListFacetAttributesResponse
- ListFacetAttributesResponse
object
- Attributes FacetAttributeList
- NextToken NextToken
ListFacetNamesRequest
- ListFacetNamesRequest
object
- MaxResults NumberResults
- NextToken NextToken
ListFacetNamesResponse
- ListFacetNamesResponse
object
- FacetNames FacetNameList
- NextToken NextToken
ListIncomingTypedLinksRequest
- ListIncomingTypedLinksRequest
object
- ConsistencyLevel ConsistencyLevel
- FilterAttributeRanges TypedLinkAttributeRangeList
- FilterTypedLink TypedLinkSchemaAndFacetName
- MaxResults NumberResults
- NextToken [NextToken