String directoryArn
SchemaFacet schemaFacet
Identifiers for the facet that you are adding to the object. See SchemaFacet for details.
List<E> objectAttributeList
Attributes on the facet that you are adding to the object.
ObjectReference objectReference
A reference to the object you are adding the specified facet to.
String directoryArn
ObjectReference parentReference
The parent object reference.
ObjectReference childReference
The child object reference to be attached to the object.
String linkName
The link name with which the child object is attached to the parent.
String attachedObjectIdentifier
The attached ObjectIdentifier, which is the child ObjectIdentifier.
String directoryArn
ObjectReference policyReference
The reference that is associated with the policy object.
ObjectReference objectReference
The reference that identifies the object to which the policy will be attached.
String directoryArn
The Amazon Resource Name (ARN) of the directory where the object and index exist.
ObjectReference indexReference
A reference to the index that you are attaching the object to.
ObjectReference targetReference
A reference to the object that you are attaching to the index.
String attachedObjectIdentifier
The ObjectIdentifier of the object that was attached to the index.
String directoryArn
The Amazon Resource Name (ARN) of the directory where you want to attach the typed link.
ObjectReference sourceObjectReference
Identifies the source object that the typed link will attach to.
ObjectReference targetObjectReference
Identifies the target object that the typed link will attach to.
TypedLinkSchemaAndFacetName typedLinkFacet
Identifies the typed link facet that is associated with the typed link.
List<E> attributes
A set of attributes that are associated with the typed link.
TypedLinkSpecifier typedLinkSpecifier
Returns a typed link specifier as output.
AttributeKey key
The key of the attribute.
TypedAttributeValue value
The value of the attribute.
String attributeName
The attribute name of the typed link.
TypedAttributeValue value
The value for the typed link.
SchemaFacet schemaFacet
Represents the facet being added to the object.
List<E> objectAttributeList
The attributes to set on the object.
ObjectReference objectReference
A reference to the object being mutated.
ObjectReference parentReference
The parent object reference.
ObjectReference childReference
The child object reference that is to be attached to the object.
String linkName
The name of the link.
String attachedObjectIdentifier
The ObjectIdentifier of the object that has been attached.
ObjectReference policyReference
The reference that is associated with the policy object.
ObjectReference objectReference
The reference that identifies the object to which the policy will be attached.
ObjectReference indexReference
A reference to the index that you are attaching the object to.
ObjectReference targetReference
A reference to the object that you are attaching to the index.
String attachedObjectIdentifier
The ObjectIdentifier of the object that was attached to the index.
ObjectReference sourceObjectReference
Identifies the source object that the typed link will attach to.
ObjectReference targetObjectReference
Identifies the target object that the typed link will attach to.
TypedLinkSchemaAndFacetName typedLinkFacet
Identifies the typed link facet that is associated with the typed link.
List<E> attributes
A set of attributes that are associated with the typed link.
TypedLinkSpecifier typedLinkSpecifier
Returns a typed link specifier as output.
List<E> orderedIndexedAttributeList
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
Boolean isUnique
Indicates whether the attribute that is being indexed has unique values or not.
ObjectReference parentReference
A reference to the parent object that contains the index object.
String linkName
The name of the link between the parent object and the index object.
String batchReferenceName
The batch reference name. See Transaction Support for more information.
String objectIdentifier
The ObjectIdentifier of the index created by this operation.
List<E> schemaFacet
A list of FacetArns that will be associated with the object. For more information, see arns.
List<E> objectAttributeList
An attribute map, which contains an attribute ARN as the key and attribute value as the map value.
ObjectReference parentReference
If specified, the parent reference to which this object will be attached.
String linkName
The name of the link.
String batchReferenceName
The batch reference name. See Transaction Support for more information.
String objectIdentifier
The ID that is associated with the object.
ObjectReference objectReference
The reference that identifies the object.
ObjectReference indexReference
A reference to the index object.
ObjectReference targetReference
A reference to the object being detached from the index.
String detachedObjectIdentifier
The ObjectIdentifier of the object that was detached from the index.
ObjectReference parentReference
Parent reference from which the object with the specified link name is detached.
String linkName
The name of the link.
String batchReferenceName
The batch reference name. See Transaction Support for more information.
String detachedObjectIdentifier
The ObjectIdentifier of the detached object.
ObjectReference policyReference
Reference that identifies the policy object.
ObjectReference objectReference
Reference that identifies the object whose policy object will be detached.
TypedLinkSpecifier typedLinkSpecifier
Used to accept a typed link specifier as input.
TypedLinkSpecifier typedLinkSpecifier
Allows a typed link specifier to be accepted as input.
List<E> attributeNames
A list of attribute names whose values will be retrieved.
ObjectReference objectReference
Reference that identifies the object whose attributes will be retrieved.
SchemaFacet schemaFacet
Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.
List<E> attributeNames
List of attribute names whose values will be retrieved.
ObjectReference objectReference
A reference to the object.
ObjectReference targetReference
A reference to the object that has indices attached.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
ObjectReference objectReference
The reference that identifies the object whose attributes will be listed.
List<E> filterAttributeRanges
Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
TypedLinkSchemaAndFacetName filterTypedLink
Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
List<E> rangesOnIndexedValues
Specifies the ranges of indexed values that you want to query.
ObjectReference indexReference
The reference to the index to list.
Integer maxResults
The maximum number of results to retrieve.
String nextToken
The pagination token.
ObjectReference objectReference
Reference of the object whose attributes need to be listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
SchemaFacet facetFilter
Used to filter the list of object attributes that are associated with a certain facet.
ObjectReference objectReference
Reference of the object for which child objects are being listed.
String nextToken
The pagination token.
Integer maxResults
Maximum number of items to be retrieved in a single call. This is an approximate number.
ObjectReference objectReference
The reference that identifies the object whose attributes will be listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
ObjectReference objectReference
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
ObjectReference objectReference
The reference that identifies the object whose attributes will be listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
ObjectReference objectReference
The reference that identifies the object whose attributes will be listed.
List<E> filterAttributeRanges
Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
TypedLinkSchemaAndFacetName filterTypedLink
Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
ObjectReference policyReference
The reference that identifies the policy object.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
ObjectReference objectReference
Reference that identifies the object whose policies will be looked up.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
BatchListObjectAttributes listObjectAttributes
Lists all attributes that are associated with an object.
BatchListObjectChildren listObjectChildren
Returns a paginated list of child objects that are associated with a given object.
BatchListAttachedIndices listAttachedIndices
Lists indices attached to an object.
BatchListObjectParentPaths listObjectParentPaths
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.
BatchGetObjectInformation getObjectInformation
Retrieves metadata about an object.
BatchGetObjectAttributes getObjectAttributes
Retrieves attributes within a facet that are associated with an object.
BatchListObjectParents listObjectParents
Lists parent objects that are associated with a given object in pagination fashion.
BatchListObjectPolicies listObjectPolicies
Returns policies attached to an object in pagination fashion.
BatchListPolicyAttachments listPolicyAttachments
Returns all of the ObjectIdentifiers to which a given policy is attached.
BatchLookupPolicy lookupPolicy
Lists all policies from the root of the Directory to the object specified. If there are no policies
present, an empty list is returned. If policies are present, and if some objects don't have the policies
attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns
ObjectIdentifier, policyId, and policyType. Paths that don't lead to the
root from the target object are ignored. For more information, see Policies.
BatchListIndex listIndex
Lists objects attached to the specified index.
BatchListOutgoingTypedLinks listOutgoingTypedLinks
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
BatchListIncomingTypedLinks listIncomingTypedLinks
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
BatchGetLinkAttributes getLinkAttributes
Retrieves attributes that are associated with a typed link.
BatchReadSuccessfulResponse successfulResponse
Identifies which operation in a batch has succeeded.
BatchReadException exceptionResponse
Identifies which operation in a batch has failed.
String directoryArn
List<E> operations
A list of operations that are part of the batch.
String consistencyLevel
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
BatchListObjectAttributesResponse listObjectAttributes
Lists all attributes that are associated with an object.
BatchListObjectChildrenResponse listObjectChildren
Returns a paginated list of child objects that are associated with a given object.
BatchGetObjectInformationResponse getObjectInformation
Retrieves metadata about an object.
BatchGetObjectAttributesResponse getObjectAttributes
Retrieves attributes within a facet that are associated with an object.
BatchListAttachedIndicesResponse listAttachedIndices
Lists indices attached to an object.
BatchListObjectParentPathsResponse listObjectParentPaths
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure.
BatchListObjectPoliciesResponse listObjectPolicies
Returns policies attached to an object in pagination fashion.
BatchListPolicyAttachmentsResponse listPolicyAttachments
Returns all of the ObjectIdentifiers to which a given policy is attached.
BatchLookupPolicyResponse lookupPolicy
Lists all policies from the root of the Directory to the object specified. If there are no policies
present, an empty list is returned. If policies are present, and if some objects don't have the policies
attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns
ObjectIdentifier, policyId, and policyType. Paths that don't lead to the
root from the target object are ignored. For more information, see Policies.
BatchListIndexResponse listIndex
Lists objects attached to the specified index.
BatchListOutgoingTypedLinksResponse listOutgoingTypedLinks
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
BatchListIncomingTypedLinksResponse listIncomingTypedLinks
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links.
BatchGetLinkAttributesResponse getLinkAttributes
The list of attributes to retrieve from the typed link.
BatchListObjectParentsResponse listObjectParents
The list of parent objects to retrieve.
SchemaFacet schemaFacet
The facet to remove from the object.
ObjectReference objectReference
A reference to the object whose facet will be removed.
TypedLinkSpecifier typedLinkSpecifier
Allows a typed link specifier to be accepted as input.
List<E> attributeUpdates
The attributes update structure.
ObjectReference objectReference
Reference that identifies the object.
List<E> attributeUpdates
Attributes update structure.
String objectIdentifier
ID that is associated with the object.
BatchCreateObject createObject
Creates an object.
BatchAttachObject attachObject
Attaches an object to a Directory.
BatchDetachObject detachObject
Detaches an object from a Directory.
BatchUpdateObjectAttributes updateObjectAttributes
Updates a given object's attributes.
BatchDeleteObject deleteObject
Deletes an object in a Directory.
BatchAddFacetToObject addFacetToObject
A batch operation that adds a facet to an object.
BatchRemoveFacetFromObject removeFacetFromObject
A batch operation that removes a facet from an object.
BatchAttachPolicy attachPolicy
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
BatchDetachPolicy detachPolicy
Detaches a policy from a Directory.
BatchCreateIndex createIndex
Creates an index object. See Indexing and search for more information.
BatchAttachToIndex attachToIndex
Attaches the specified object to the specified index.
BatchDetachFromIndex detachFromIndex
Detaches the specified object from the specified index.
BatchAttachTypedLink attachTypedLink
Attaches a typed link to a specified source and target object. For more information, see Typed Links.
BatchDetachTypedLink detachTypedLink
Detaches a typed link from a specified source and target object. For more information, see Typed Links.
BatchUpdateLinkAttributes updateLinkAttributes
Updates a given object's attributes.
BatchCreateObjectResponse createObject
Creates an object in a Directory.
BatchAttachObjectResponse attachObject
Attaches an object to a Directory.
BatchDetachObjectResponse detachObject
Detaches an object from a Directory.
BatchUpdateObjectAttributesResponse updateObjectAttributes
Updates a given object’s attributes.
BatchDeleteObjectResponse deleteObject
Deletes an object in a Directory.
BatchAddFacetToObjectResponse addFacetToObject
The result of an add facet to object batch operation.
BatchRemoveFacetFromObjectResponse removeFacetFromObject
The result of a batch remove facet from object operation.
BatchAttachPolicyResponse attachPolicy
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
BatchDetachPolicyResponse detachPolicy
Detaches a policy from a Directory.
BatchCreateIndexResponse createIndex
Creates an index object. See Indexing and search for more information.
BatchAttachToIndexResponse attachToIndex
Attaches the specified object to the specified index.
BatchDetachFromIndexResponse detachFromIndex
Detaches the specified object from the specified index.
BatchAttachTypedLinkResponse attachTypedLink
Attaches a typed link to a specified source and target object. For more information, see Typed Links.
BatchDetachTypedLinkResponse detachTypedLink
Detaches a typed link from a specified source and target object. For more information, see Typed Links.
BatchUpdateLinkAttributesResponse updateLinkAttributes
Represents the output of a BatchWrite response operation.
String schemaArn
String name
The name of the Facet, which is unique for a given schema.
List<E> attributes
The attributes that are associated with the Facet.
String 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.
String 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.
String directoryArn
The ARN of the directory where the index should be created.
List<E> orderedIndexedAttributeList
Specifies the attributes that should be indexed on. Currently only a single attribute is supported.
Boolean isUnique
Indicates whether the attribute that is being indexed has unique values or not.
ObjectReference parentReference
A reference to the parent object that contains the index object.
String linkName
The name of the link between the parent object and the index object.
String objectIdentifier
The ObjectIdentifier of the index created by this operation.
String directoryArn
List<E> schemaFacets
A list of schema facets to be associated with the object. Do not provide minor version components. See SchemaFacet for details.
List<E> objectAttributeList
The attribute map whose attribute ARN contains the key and attribute value as the map value.
ObjectReference parentReference
If specified, the parent reference to which this object will be attached.
String linkName
The name of link that is used to attach this object to a parent.
String objectIdentifier
The identifier that is associated with the object.
String name
The name that is associated with the schema. This is unique to each account and in each region.
String schemaArn
The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
TypedLinkFacet facet
Facet structure that is associated with the typed link facet.
String directoryArn
The ARN of the directory to delete.
String directoryArn
The ARN of the deleted directory.
String directoryArn
ObjectReference objectReference
A reference that identifies the object.
String directoryArn
The Amazon Resource Name (ARN) of the directory the index and object exist in.
ObjectReference indexReference
A reference to the index object.
ObjectReference targetReference
A reference to the object being detached from the index.
String detachedObjectIdentifier
The ObjectIdentifier of the object that was detached from the index.
String directoryArn
ObjectReference parentReference
The parent reference from which the object with the specified link name is detached.
String linkName
The link name associated with the object that needs to be detached.
String detachedObjectIdentifier
The ObjectIdentifier that was detached from the object.
String directoryArn
ObjectReference policyReference
Reference that identifies the policy object.
ObjectReference objectReference
Reference that identifies the object whose policy object will be detached.
String directoryArn
The Amazon Resource Name (ARN) of the directory where you want to detach the typed link.
TypedLinkSpecifier typedLinkSpecifier
Used to accept a typed link specifier as input.
String name
The name of the directory.
String directoryArn
The Amazon Resource Name (ARN) that is associated with the directory. For more information, see arns.
String state
The state of the directory. Can be either Enabled, Disabled, or Deleted.
Date creationDateTime
The date and time when the directory was created.
String directoryArn
The ARN of the directory to disable.
String directoryArn
The ARN of the directory that has been disabled.
String directoryArn
The ARN of the directory to enable.
String directoryArn
The ARN of the enabled directory.
String name
The name of the Facet.
String objectType
The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
String 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.
String name
The name of the facet attribute.
FacetAttributeDefinition attributeDefinition
A facet attribute consists of either a definition or a reference. This structure contains the attribute definition. See Attribute References for more information.
FacetAttributeReference attributeReference
An attribute reference that is associated with the attribute. See Attribute References for more information.
String requiredBehavior
The required behavior of the FacetAttribute.
String targetFacetName
The target facet name that is associated with the facet reference. See Attribute References for more information.
String targetAttributeName
The target attribute name that is associated with the facet reference. See Attribute References for more information.
FacetAttribute attribute
The attribute to update.
String action
The action to perform when updating the attribute.
String schemaArn
The ARN of the applied schema.
String appliedSchemaArn
Current applied schema ARN, including the minor version in use if one was provided.
String directoryArn
The ARN of the directory.
Directory directory
Metadata about the directory.
String directoryArn
The Amazon Resource Name (ARN) that is associated with the Directory where the typed link resides. For more information, see arns or Typed Links.
TypedLinkSpecifier typedLinkSpecifier
Allows a typed link specifier to be accepted as input.
List<E> attributeNames
A list of attribute names whose values will be retrieved.
String consistencyLevel
The consistency level at which to retrieve the attributes on a typed link.
String directoryArn
The Amazon Resource Name (ARN) that is associated with the Directory where the object resides.
ObjectReference objectReference
Reference that identifies the object whose attributes will be retrieved.
String consistencyLevel
The consistency level at which to retrieve the attributes on an object.
SchemaFacet schemaFacet
Identifier for the facet whose attributes will be retrieved. See SchemaFacet for details.
List<E> attributeNames
List of attribute names whose values will be retrieved.
String directoryArn
The ARN of the directory being retrieved.
ObjectReference objectReference
A reference to the object.
String consistencyLevel
The consistency level at which to retrieve the object information.
List<E> schemaFacets
The facets attached to the specified object. Although the response does not include minor version information, the most recently applied minor version of each Facet is in effect. See GetAppliedSchemaVersion for details.
String objectIdentifier
The ObjectIdentifier of the specified object.
String schemaArn
The ARN of the schema to retrieve.
List<E> identityAttributeOrder
The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.
List<E> indexedAttributes
The indexed attribute values.
String objectIdentifier
In response to ListIndex, the ObjectIdentifier of the object attached to the index. In
response to ListAttachedIndices, the ObjectIdentifier of the index attached to the object.
This field will always contain the ObjectIdentifier of the object on the opposite side of the
attachment specified in the query.
String attributeActionType
A type that can be either UPDATE_OR_CREATE or DELETE.
TypedAttributeValue attributeUpdateValue
The value that you want to update to.
AttributeKey attributeKey
The key of the attribute being updated.
LinkAttributeAction attributeAction
The action to perform as part of the attribute update.
String directoryArn
The ARN of the directory you are listing.
String schemaArn
The response for ListAppliedSchemaArns when this parameter is used will list all minor version ARNs
for a major version.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
String directoryArn
The ARN of the directory.
ObjectReference targetReference
A reference to the object that has indices attached.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
String consistencyLevel
The consistency level to use for this operation.
String directoryArn
The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
ObjectReference objectReference
Reference that identifies the object whose attributes will be listed.
List<E> filterAttributeRanges
Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
TypedLinkSchemaAndFacetName filterTypedLink
Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
String consistencyLevel
The consistency level to execute the request at.
String directoryArn
The ARN of the directory that the index exists in.
List<E> rangesOnIndexedValues
Specifies the ranges of indexed values that you want to query.
ObjectReference indexReference
The reference to the index to list.
Integer maxResults
The maximum number of objects in a single page to retrieve from the index during a request. For more information, see Amazon Cloud Directory Limits.
String nextToken
The pagination token.
String consistencyLevel
The consistency level to execute the request at.
String directoryArn
ObjectReference objectReference
The reference that identifies the object whose attributes will be listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String consistencyLevel
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
SchemaFacet facetFilter
Used to filter the list of object attributes that are associated with a certain facet.
String directoryArn
ObjectReference objectReference
The reference that identifies the object for which child objects are being listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String consistencyLevel
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
String directoryArn
The ARN of the directory to which the parent path applies.
ObjectReference objectReference
The reference that identifies the object whose parent paths are listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String directoryArn
ObjectReference objectReference
The reference that identifies the object for which parent objects are being listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String consistencyLevel
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
Boolean includeAllLinksToEachParent
When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.
String directoryArn
ObjectReference objectReference
Reference that identifies the object for which policies will be listed.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String consistencyLevel
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
String directoryArn
The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
ObjectReference objectReference
A reference that identifies the object whose attributes will be listed.
List<E> filterAttributeRanges
Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
TypedLinkSchemaAndFacetName filterTypedLink
Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
String consistencyLevel
The consistency level to execute the request at.
String directoryArn
ObjectReference policyReference
The reference that identifies the policy object.
String nextToken
The pagination token.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String consistencyLevel
Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.
String resourceArn
The Amazon Resource Name (ARN) of the resource. Tagging is only supported for directories.
String nextToken
The pagination token. This is for future use. Currently pagination is not supported for tagging.
Integer maxResults
The MaxResults parameter sets the maximum number of results returned in a single page. This is for
future use and is not supported currently.
String schemaArn
The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
String name
The unique name of the typed link facet.
String nextToken
The pagination token.
Integer maxResults
The maximum number of results to retrieve.
String directoryArn
ObjectReference objectReference
Reference that identifies the object whose policies will be looked up.
String nextToken
The token to request the next page of results.
Integer maxResults
The maximum number of items to be retrieved in a single call. This is an approximate number.
String objectAttributeActionType
A type that can be either Update or Delete.
TypedAttributeValue objectAttributeUpdateValue
The value that you want to update to.
AttributeKey attributeKey
The key of the attribute that the attribute range covers.
TypedAttributeValueRange range
The range of attribute values being selected.
AttributeKey objectAttributeKey
The key of the attribute being updated.
ObjectAttributeAction objectAttributeAction
The action to perform as part of the attribute update.
String selector
A path selector supports easy selection of an object by the parent/child links leading to it from the directory root. Use the link names from each parent/child link to construct the path. Path selectors start with a slash (/) and link names are separated by slashes. For more information about paths, see Access Objects. You can identify an object in one of the following ways:
$ObjectIdentifier - An object identifier is an opaque string provided by Amazon Cloud Directory. When creating objects, the system will provide you with the identifier of the created object. An object’s identifier is immutable and no two objects will ever share the same object identifier. To identify an object with ObjectIdentifier, the ObjectIdentifier must be wrapped in double quotes.
/some/path - Identifies the object based on path
#SomeBatchReference - Identifies the object in a batch call
String developmentSchemaArn
The Amazon Resource Name (ARN) that is associated with the development schema. For more information, see arns.
String version
The major version under which the schema will be published. Schemas have both a major and minor version associated with them.
String minorVersion
The minor version under which the schema will be published. This parameter is recommended. Schemas have both a major and minor version associated with them.
String name
The new name under which the schema will be published. If this is not provided, the development schema is considered.
String arn
The ARN of the schema to update.
String directoryArn
The ARN of the directory in which the object resides.
SchemaFacet schemaFacet
The facet to remove. See SchemaFacet for details.
ObjectReference objectReference
A reference to the object to remove the facet from.
String schemaArn
The ARN of the schema that contains the facet with no minor component. See arns and In-Place Schema Upgrade for a description of when to provide minor versions. If this value is set, FacetName must also be set.
String facetName
The name of the facet. If this value is set, SchemaArn must also be set.
String stringValue
A string data value.
ByteBuffer binaryValue
A binary data value.
Boolean booleanValue
A Boolean data value.
String numberValue
A number data value.
Date datetimeValue
A date and time value.
String startMode
The inclusive or exclusive range start.
TypedAttributeValue startValue
The value to start the range at.
String endMode
The inclusive or exclusive range end.
TypedAttributeValue endValue
The attribute value to terminate the range at.
String name
The unique name of the typed link attribute.
String type
The type of the attribute.
TypedAttributeValue defaultValue
The default value of the attribute (if configured).
Boolean isImmutable
Whether the attribute is mutable or not.
Map<K,V> rules
Validation rules that are attached to the attribute definition.
String requiredBehavior
The required behavior of the TypedLinkAttributeDefinition.
String attributeName
The unique name of the typed link attribute.
TypedAttributeValueRange range
The range of attribute values that are being selected.
String name
The unique name of the typed link facet.
List<E> attributes
A set of key-value pairs associated with the typed link. Typed link attributes are used when you have data values that are related to the link itself, and not to one of the two objects being linked. Identity attributes also serve to distinguish the link from others of the same type between the same objects.
List<E> identityAttributeOrder
The set of attributes that distinguish links made from this facet from each other, in the order of significance. Listing typed links can filter on the values of these attributes. See ListOutgoingTypedLinks and ListIncomingTypedLinks for details.
TypedLinkAttributeDefinition attribute
The attribute to update.
String action
The action to perform when updating the attribute.
TypedLinkSchemaAndFacetName typedLinkFacet
Identifies the typed link facet that is associated with the typed link.
ObjectReference sourceObjectReference
Identifies the source object that the typed link will attach to.
ObjectReference targetObjectReference
Identifies the target object that the typed link will attach to.
List<E> identityAttributeValues
Identifies the attribute value to update.
String schemaArn
String name
The name of the facet.
List<E> attributeUpdates
List of attributes that need to be updated in a given schema Facet. Each attribute is followed by
AttributeAction, which specifies the type of update operation to perform.
String objectType
The object type that is associated with the facet. See CreateFacetRequest$ObjectType for more details.
String directoryArn
The Amazon Resource Name (ARN) that is associated with the Directory where the updated typed link resides. For more information, see arns or Typed Links.
TypedLinkSpecifier typedLinkSpecifier
Allows a typed link specifier to be accepted as input.
List<E> attributeUpdates
The attributes update structure.
String directoryArn
ObjectReference objectReference
The reference that identifies the object.
List<E> attributeUpdates
The attributes update structure.
String objectIdentifier
The ObjectIdentifier of the updated object.
String schemaArn
The Amazon Resource Name (ARN) that is associated with the schema. For more information, see arns.
String name
The unique name of the typed link facet.
List<E> attributeUpdates
Attributes update structure.
List<E> identityAttributeOrder
The order of identity attributes for the facet, from most significant to least significant. The ability to filter typed links considers the order that the attributes are defined on the typed link facet. When providing ranges to a typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range. Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls. For more information about identity attributes, see Typed Links.
String publishedSchemaArn
The revision of the published schema to upgrade the directory to.
String directoryArn
The ARN for the directory to which the upgraded schema will be applied.
Boolean dryRun
Used for testing whether the major version schemas are backward compatible or not. If schema compatibility fails, an exception would be thrown else the call would succeed but no changes will be saved. This parameter is optional.
String developmentSchemaArn
The ARN of the development schema with the changes used for the upgrade.
String publishedSchemaArn
The ARN of the published schema to be upgraded.
String minorVersion
Identifies the minor version of the published schema that will be created. This parameter is NOT optional.
Boolean dryRun
Used for testing whether the Development schema provided is backwards compatible, or not, with the publish schema provided by the user to be upgraded. If schema compatibility fails, an exception would be thrown else the call would succeed. This parameter is optional and defaults to false.
String upgradedSchemaArn
The ARN of the upgraded schema that is returned as part of the response.
Copyright © 2021. All rights reserved.