types

package
v1.20.4 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 29, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Access denied or directory not found. Either you don't have permissions for this directory or the directory does not exist. Try calling ListDirectories and check your permissions.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AttributeKey 

type AttributeKey struct {

	// The name of the facet that the attribute exists within.
	//
	// This member is required.
	FacetName *string

	// The name of the attribute.
	//
	// This member is required.
	Name *string

	// The Amazon Resource Name (ARN) of the schema that contains the facet and
	// attribute.
	//
	// This member is required.
	SchemaArn *string
	// contains filtered or unexported fields
}

A unique identifier for an attribute.

type AttributeKeyAndValue 

type AttributeKeyAndValue struct {

	// The key of the attribute.
	//
	// This member is required.
	Key *AttributeKey

	// The value of the attribute.
	//
	// This member is required.
	Value TypedAttributeValue
	// contains filtered or unexported fields
}

The combination of an attribute key and an attribute value.

type AttributeNameAndValue 

type AttributeNameAndValue struct {

	// The attribute name of the typed link.
	//
	// This member is required.
	AttributeName *string

	// The value for the typed link.
	//
	// This member is required.
	Value TypedAttributeValue
	// contains filtered or unexported fields
}

Identifies the attribute name and value for a typed link.

type BatchAddFacetToObject 

type BatchAddFacetToObject struct {

	// The attributes to set on the object.
	//
	// This member is required.
	ObjectAttributeList []AttributeKeyAndValue

	// A reference to the object being mutated.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// Represents the facet being added to the object.
	//
	// This member is required.
	SchemaFacet *SchemaFacet
	// contains filtered or unexported fields
}

Represents the output of a batch add facet to object operation.

type BatchAddFacetToObjectResponse 

type BatchAddFacetToObjectResponse struct {
	// contains filtered or unexported fields
}

The result of a batch add facet to object operation.

type BatchAttachObject 

type BatchAttachObject struct {

	// The child object reference that is to be attached to the object.
	//
	// This member is required.
	ChildReference *ObjectReference

	// The name of the link.
	//
	// This member is required.
	LinkName *string

	// The parent object reference.
	//
	// This member is required.
	ParentReference *ObjectReference
	// contains filtered or unexported fields
}

Represents the output of an AttachObject operation.

type BatchAttachObjectResponse 

type BatchAttachObjectResponse struct {

	// The ObjectIdentifier of the object that has been attached.
	AttachedObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output batch AttachObject response operation.

type BatchAttachPolicy 

type BatchAttachPolicy struct {

	// The reference that identifies the object to which the policy will be attached.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// The reference that is associated with the policy object.
	//
	// This member is required.
	PolicyReference *ObjectReference
	// contains filtered or unexported fields
}

Attaches a policy object to a regular object inside a BatchRead operation. For more information, see AttachPolicy and BatchReadRequest$Operations .

type BatchAttachPolicyResponse 

type BatchAttachPolicyResponse struct {
	// contains filtered or unexported fields
}

Represents the output of an AttachPolicy response operation.

type BatchAttachToIndex 

type BatchAttachToIndex struct {

	// A reference to the index that you are attaching the object to.
	//
	// This member is required.
	IndexReference *ObjectReference

	// A reference to the object that you are attaching to the index.
	//
	// This member is required.
	TargetReference *ObjectReference
	// contains filtered or unexported fields
}

Attaches the specified object to the specified index inside a BatchRead operation. For more information, see AttachToIndex and BatchReadRequest$Operations .

type BatchAttachToIndexResponse 

type BatchAttachToIndexResponse struct {

	// The ObjectIdentifier of the object that was attached to the index.
	AttachedObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output of a AttachToIndex response operation. 

type BatchAttachTypedLink struct {

	// A set of attributes that are associated with the typed link.
	//
	// This member is required.
	Attributes []AttributeNameAndValue

	// Identifies the source object that the typed link will attach to.
	//
	// This member is required.
	SourceObjectReference *ObjectReference

	// Identifies the target object that the typed link will attach to.
	//
	// This member is required.
	TargetObjectReference *ObjectReference

	// Identifies the typed link facet that is associated with the typed link.
	//
	// This member is required.
	TypedLinkFacet *TypedLinkSchemaAndFacetName
	// contains filtered or unexported fields
}

Attaches a typed link to a specified source and target object inside a BatchRead operation. For more information, see AttachTypedLink and BatchReadRequest$Operations .

type BatchAttachTypedLinkResponse 

type BatchAttachTypedLinkResponse struct {

	// Returns a typed link specifier as output.
	TypedLinkSpecifier *TypedLinkSpecifier
	// contains filtered or unexported fields
}

Represents the output of a AttachTypedLink response operation.

type BatchCreateIndex 

type BatchCreateIndex struct {

	// Indicates whether the attribute that is being indexed has unique values or not.
	//
	// This member is required.
	IsUnique bool

	// Specifies the attributes that should be indexed on. Currently only a single
	// attribute is supported.
	//
	// This member is required.
	OrderedIndexedAttributeList []AttributeKey

	// The batch reference name. See Transaction Support (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html)
	// for more information.
	BatchReferenceName *string

	// The name of the link between the parent object and the index object.
	LinkName *string

	// A reference to the parent object that contains the index object.
	ParentReference *ObjectReference
	// contains filtered or unexported fields
}

Creates an index object inside of a BatchRead operation. For more information, see CreateIndex and BatchReadRequest$Operations .

type BatchCreateIndexResponse 

type BatchCreateIndexResponse struct {

	// The ObjectIdentifier of the index created by this operation.
	ObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output of a CreateIndex response operation.

type BatchCreateObject 

type BatchCreateObject struct {

	// An attribute map, which contains an attribute ARN as the key and attribute
	// value as the map value.
	//
	// This member is required.
	ObjectAttributeList []AttributeKeyAndValue

	// A list of FacetArns that will be associated with the object. For more
	// information, see arns .
	//
	// This member is required.
	SchemaFacet []SchemaFacet

	// The batch reference name. See Transaction Support (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html)
	// for more information.
	BatchReferenceName *string

	// The name of the link.
	LinkName *string

	// If specified, the parent reference to which this object will be attached.
	ParentReference *ObjectReference
	// contains filtered or unexported fields
}

Represents the output of a CreateObject operation.

type BatchCreateObjectResponse 

type BatchCreateObjectResponse struct {

	// The ID that is associated with the object.
	ObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output of a CreateObject response operation.

type BatchDeleteObject 

type BatchDeleteObject struct {

	// The reference that identifies the object.
	//
	// This member is required.
	ObjectReference *ObjectReference
	// contains filtered or unexported fields
}

Represents the output of a DeleteObject operation.

type BatchDeleteObjectResponse 

type BatchDeleteObjectResponse struct {
	// contains filtered or unexported fields
}

Represents the output of a DeleteObject response operation.

type BatchDetachFromIndex 

type BatchDetachFromIndex struct {

	// A reference to the index object.
	//
	// This member is required.
	IndexReference *ObjectReference

	// A reference to the object being detached from the index.
	//
	// This member is required.
	TargetReference *ObjectReference
	// contains filtered or unexported fields
}

Detaches the specified object from the specified index inside a BatchRead operation. For more information, see DetachFromIndex and BatchReadRequest$Operations .

type BatchDetachFromIndexResponse 

type BatchDetachFromIndexResponse struct {

	// The ObjectIdentifier of the object that was detached from the index.
	DetachedObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output of a DetachFromIndex response operation.

type BatchDetachObject 

type BatchDetachObject struct {

	// The name of the link.
	//
	// This member is required.
	LinkName *string

	// Parent reference from which the object with the specified link name is detached.
	//
	// This member is required.
	ParentReference *ObjectReference

	// The batch reference name. See Transaction Support (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/transaction_support.html)
	// for more information.
	BatchReferenceName *string
	// contains filtered or unexported fields
}

Represents the output of a DetachObject operation.

type BatchDetachObjectResponse 

type BatchDetachObjectResponse struct {

	// The ObjectIdentifier of the detached object.
	DetachedObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output of a DetachObject response operation.

type BatchDetachPolicy 

type BatchDetachPolicy struct {

	// Reference that identifies the object whose policy object will be detached.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// Reference that identifies the policy object.
	//
	// This member is required.
	PolicyReference *ObjectReference
	// contains filtered or unexported fields
}

Detaches the specified policy from the specified directory inside a BatchWrite operation. For more information, see DetachPolicy and BatchWriteRequest$Operations .

type BatchDetachPolicyResponse 

type BatchDetachPolicyResponse struct {
	// contains filtered or unexported fields
}

Represents the output of a DetachPolicy response operation. 

type BatchDetachTypedLink struct {

	// Used to accept a typed link specifier as input.
	//
	// This member is required.
	TypedLinkSpecifier *TypedLinkSpecifier
	// contains filtered or unexported fields
}

Detaches a typed link from a specified source and target object inside a BatchRead operation. For more information, see DetachTypedLink and BatchReadRequest$Operations .

type BatchDetachTypedLinkResponse 

type BatchDetachTypedLinkResponse struct {
	// contains filtered or unexported fields
}

Represents the output of a DetachTypedLink response operation.

type BatchGetLinkAttributes 

type BatchGetLinkAttributes struct {

	// A list of attribute names whose values will be retrieved.
	//
	// This member is required.
	AttributeNames []string

	// Allows a typed link specifier to be accepted as input.
	//
	// This member is required.
	TypedLinkSpecifier *TypedLinkSpecifier
	// contains filtered or unexported fields
}

Retrieves attributes that are associated with a typed link inside a BatchRead operation. For more information, see GetLinkAttributes and BatchReadRequest$Operations .

type BatchGetLinkAttributesResponse 

type BatchGetLinkAttributesResponse struct {

	// The attributes that are associated with the typed link.
	Attributes []AttributeKeyAndValue
	// contains filtered or unexported fields
}

Represents the output of a GetLinkAttributes response operation.

type BatchGetObjectAttributes 

type BatchGetObjectAttributes struct {

	// List of attribute names whose values will be retrieved.
	//
	// This member is required.
	AttributeNames []string

	// Reference that identifies the object whose attributes will be retrieved.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// Identifier for the facet whose attributes will be retrieved. See SchemaFacet
	// for details.
	//
	// This member is required.
	SchemaFacet *SchemaFacet
	// contains filtered or unexported fields
}

Retrieves attributes within a facet that are associated with an object inside an BatchRead operation. For more information, see GetObjectAttributes and BatchReadRequest$Operations .

type BatchGetObjectAttributesResponse 

type BatchGetObjectAttributesResponse struct {

	// The attribute values that are associated with an object.
	Attributes []AttributeKeyAndValue
	// contains filtered or unexported fields
}

Represents the output of a GetObjectAttributes response operation.

type BatchGetObjectInformation 

type BatchGetObjectInformation struct {

	// A reference to the object.
	//
	// This member is required.
	ObjectReference *ObjectReference
	// contains filtered or unexported fields
}

Retrieves metadata about an object inside a BatchRead operation. For more information, see GetObjectInformation and BatchReadRequest$Operations .

type BatchGetObjectInformationResponse 

type BatchGetObjectInformationResponse struct {

	// The ObjectIdentifier of the specified object.
	ObjectIdentifier *string

	// The facets attached to the specified object.
	SchemaFacets []SchemaFacet
	// contains filtered or unexported fields
}

Represents the output of a GetObjectInformation response operation.

type BatchListAttachedIndices 

type BatchListAttachedIndices struct {

	// A reference to the object that has indices attached.
	//
	// This member is required.
	TargetReference *ObjectReference

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Lists indices attached to an object inside a BatchRead operation. For more information, see ListAttachedIndices and BatchReadRequest$Operations .

type BatchListAttachedIndicesResponse 

type BatchListAttachedIndicesResponse struct {

	// The indices attached to the specified object.
	IndexAttachments []IndexAttachment

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListAttachedIndices response operation. 

type BatchListIncomingTypedLinks struct {

	// The reference that identifies the object whose attributes will be listed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// 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.
	FilterAttributeRanges []TypedLinkAttributeRange

	// 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.
	FilterTypedLink *TypedLinkSchemaAndFacetName

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

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 .

type BatchListIncomingTypedLinksResponse 

type BatchListIncomingTypedLinksResponse struct {

	// Returns one or more typed link specifiers as output.
	LinkSpecifiers []TypedLinkSpecifier

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListIncomingTypedLinks response operation.

type BatchListIndex 

type BatchListIndex struct {

	// The reference to the index to list.
	//
	// This member is required.
	IndexReference *ObjectReference

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string

	// Specifies the ranges of indexed values that you want to query.
	RangesOnIndexedValues []ObjectAttributeRange
	// contains filtered or unexported fields
}

Lists objects attached to the specified index inside a BatchRead operation. For more information, see ListIndex and BatchReadRequest$Operations .

type BatchListIndexResponse 

type BatchListIndexResponse struct {

	// The objects and indexed values attached to the index.
	IndexAttachments []IndexAttachment

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListIndex response operation.

type BatchListObjectAttributes 

type BatchListObjectAttributes struct {

	// Reference of the object whose attributes need to be listed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// Used to filter the list of object attributes that are associated with a certain
	// facet.
	FacetFilter *SchemaFacet

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListObjectAttributes operation.

type BatchListObjectAttributesResponse 

type BatchListObjectAttributesResponse struct {

	// The attributes map that is associated with the object. AttributeArn is the key;
	// attribute value is the value.
	Attributes []AttributeKeyAndValue

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListObjectAttributes response operation.

type BatchListObjectChildren 

type BatchListObjectChildren struct {

	// Reference of the object for which child objects are being listed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// Maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListObjectChildren operation.

type BatchListObjectChildrenResponse 

type BatchListObjectChildrenResponse struct {

	// The children structure, which is a map with the key as the LinkName and
	// ObjectIdentifier as the value.
	Children map[string]string

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListObjectChildren response operation.

type BatchListObjectParentPaths 

type BatchListObjectParentPaths struct {

	// The reference that identifies the object whose attributes will be listed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

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 .

type BatchListObjectParentPathsResponse 

type BatchListObjectParentPathsResponse struct {

	// The pagination token.
	NextToken *string

	// Returns the path to the ObjectIdentifiers that are associated with the
	// directory.
	PathToObjectIdentifiersList []PathToObjectIdentifiers
	// contains filtered or unexported fields
}

Represents the output of a ListObjectParentPaths response operation.

type BatchListObjectParents 

type BatchListObjectParents struct {

	// The reference that identifies an object.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Lists parent objects that are associated with a given object in pagination fashion.

type BatchListObjectParentsResponse 

type BatchListObjectParentsResponse struct {

	// The pagination token.
	NextToken *string

	// Returns a list of parent reference and LinkName Tuples.
	ParentLinks []ObjectIdentifierAndLinkNameTuple
	// contains filtered or unexported fields
}

Represents the output of a ListObjectParents response operation.

type BatchListObjectPolicies 

type BatchListObjectPolicies struct {

	// The reference that identifies the object whose attributes will be listed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Returns policies attached to an object in pagination fashion inside a BatchRead operation. For more information, see ListObjectPolicies and BatchReadRequest$Operations .

type BatchListObjectPoliciesResponse 

type BatchListObjectPoliciesResponse struct {

	// A list of policy ObjectIdentifiers , that are attached to the object.
	AttachedPolicyIds []string

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Represents the output of a ListObjectPolicies response operation. 

type BatchListOutgoingTypedLinks struct {

	// The reference that identifies the object whose attributes will be listed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// 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.
	FilterAttributeRanges []TypedLinkAttributeRange

	// 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.
	FilterTypedLink *TypedLinkSchemaAndFacetName

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

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 .

type BatchListOutgoingTypedLinksResponse 

type BatchListOutgoingTypedLinksResponse struct {

	// The pagination token.
	NextToken *string

	// Returns a typed link specifier as output.
	TypedLinkSpecifiers []TypedLinkSpecifier
	// contains filtered or unexported fields
}

Represents the output of a ListOutgoingTypedLinks response operation.

type BatchListPolicyAttachments 

type BatchListPolicyAttachments struct {

	// The reference that identifies the policy object.
	//
	// This member is required.
	PolicyReference *ObjectReference

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

Returns all of the ObjectIdentifiers to which a given policy is attached inside a BatchRead operation. For more information, see ListPolicyAttachments and BatchReadRequest$Operations .

type BatchListPolicyAttachmentsResponse 

type BatchListPolicyAttachmentsResponse struct {

	// The pagination token.
	NextToken *string

	// A list of ObjectIdentifiers to which the policy is attached.
	ObjectIdentifiers []string
	// contains filtered or unexported fields
}

Represents the output of a ListPolicyAttachments response operation.

type BatchLookupPolicy 

type BatchLookupPolicy struct {

	// Reference that identifies the object whose policies will be looked up.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// The maximum number of results to retrieve.
	MaxResults *int32

	// The pagination token.
	NextToken *string
	// contains filtered or unexported fields
}

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 .

type BatchLookupPolicyResponse 

type BatchLookupPolicyResponse struct {

	// The pagination token.
	NextToken *string

	// Provides list of path to policies. Policies contain PolicyId , ObjectIdentifier
	// , and PolicyType . For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies)
	// .
	PolicyToPathList []PolicyToPath
	// contains filtered or unexported fields
}

Represents the output of a LookupPolicy response operation.

type BatchReadException 

type BatchReadException struct {

	// An exception message that is associated with the failure.
	Message *string

	// A type of exception, such as InvalidArnException .
	Type BatchReadExceptionType
	// contains filtered or unexported fields
}

The batch read exception structure, which contains the exception type and message.

type BatchReadExceptionType 

type BatchReadExceptionType string
const (
	BatchReadExceptionTypeValidationException             BatchReadExceptionType = "ValidationException"
	BatchReadExceptionTypeInvalidArnException             BatchReadExceptionType = "InvalidArnException"
	BatchReadExceptionTypeResourceNotFoundException       BatchReadExceptionType = "ResourceNotFoundException"
	BatchReadExceptionTypeInvalidNextTokenException       BatchReadExceptionType = "InvalidNextTokenException"
	BatchReadExceptionTypeAccessDeniedException           BatchReadExceptionType = "AccessDeniedException"
	BatchReadExceptionTypeNotNodeException                BatchReadExceptionType = "NotNodeException"
	BatchReadExceptionTypeFacetValidationException        BatchReadExceptionType = "FacetValidationException"
	BatchReadExceptionTypeCannotListParentOfRootException BatchReadExceptionType = "CannotListParentOfRootException"
	BatchReadExceptionTypeNotIndexException               BatchReadExceptionType = "NotIndexException"
	BatchReadExceptionTypeNotPolicyException              BatchReadExceptionType = "NotPolicyException"
	BatchReadExceptionTypeDirectoryNotEnabledException    BatchReadExceptionType = "DirectoryNotEnabledException"
	BatchReadExceptionTypeLimitExceededException          BatchReadExceptionType = "LimitExceededException"
	BatchReadExceptionTypeInternalServiceException        BatchReadExceptionType = "InternalServiceException"
)

Enum values for BatchReadExceptionType

func (BatchReadExceptionType) Values added in v0.29.0 

func (BatchReadExceptionType) Values() []BatchReadExceptionType

Values returns all known values for BatchReadExceptionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BatchReadOperation 

type BatchReadOperation struct {

	// Retrieves attributes that are associated with a typed link.
	GetLinkAttributes *BatchGetLinkAttributes

	// Retrieves attributes within a facet that are associated with an object.
	GetObjectAttributes *BatchGetObjectAttributes

	// Retrieves metadata about an object.
	GetObjectInformation *BatchGetObjectInformation

	// Lists indices attached to an object.
	ListAttachedIndices *BatchListAttachedIndices

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	ListIncomingTypedLinks *BatchListIncomingTypedLinks

	// Lists objects attached to the specified index.
	ListIndex *BatchListIndex

	// Lists all attributes that are associated with an object.
	ListObjectAttributes *BatchListObjectAttributes

	// Returns a paginated list of child objects that are associated with a given
	// object.
	ListObjectChildren *BatchListObjectChildren

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html)
	// .
	ListObjectParentPaths *BatchListObjectParentPaths

	// Lists parent objects that are associated with a given object in pagination
	// fashion.
	ListObjectParents *BatchListObjectParents

	// Returns policies attached to an object in pagination fashion.
	ListObjectPolicies *BatchListObjectPolicies

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	ListOutgoingTypedLinks *BatchListOutgoingTypedLinks

	// Returns all of the ObjectIdentifiers to which a given policy is attached.
	ListPolicyAttachments *BatchListPolicyAttachments

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies)
	// .
	LookupPolicy *BatchLookupPolicy
	// contains filtered or unexported fields
}

Represents the output of a BatchRead operation.

type BatchReadOperationResponse 

type BatchReadOperationResponse struct {

	// Identifies which operation in a batch has failed.
	ExceptionResponse *BatchReadException

	// Identifies which operation in a batch has succeeded.
	SuccessfulResponse *BatchReadSuccessfulResponse
	// contains filtered or unexported fields
}

Represents the output of a BatchRead response operation.

type BatchReadSuccessfulResponse 

type BatchReadSuccessfulResponse struct {

	// The list of attributes to retrieve from the typed link.
	GetLinkAttributes *BatchGetLinkAttributesResponse

	// Retrieves attributes within a facet that are associated with an object.
	GetObjectAttributes *BatchGetObjectAttributesResponse

	// Retrieves metadata about an object.
	GetObjectInformation *BatchGetObjectInformationResponse

	// Lists indices attached to an object.
	ListAttachedIndices *BatchListAttachedIndicesResponse

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	ListIncomingTypedLinks *BatchListIncomingTypedLinksResponse

	// Lists objects attached to the specified index.
	ListIndex *BatchListIndexResponse

	// Lists all attributes that are associated with an object.
	ListObjectAttributes *BatchListObjectAttributesResponse

	// Returns a paginated list of child objects that are associated with a given
	// object.
	ListObjectChildren *BatchListObjectChildrenResponse

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html)
	// .
	ListObjectParentPaths *BatchListObjectParentPathsResponse

	// The list of parent objects to retrieve.
	ListObjectParents *BatchListObjectParentsResponse

	// Returns policies attached to an object in pagination fashion.
	ListObjectPolicies *BatchListObjectPoliciesResponse

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	ListOutgoingTypedLinks *BatchListOutgoingTypedLinksResponse

	// Returns all of the ObjectIdentifiers to which a given policy is attached.
	ListPolicyAttachments *BatchListPolicyAttachmentsResponse

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies)
	// .
	LookupPolicy *BatchLookupPolicyResponse
	// contains filtered or unexported fields
}

Represents the output of a BatchRead success response operation.

type BatchRemoveFacetFromObject 

type BatchRemoveFacetFromObject struct {

	// A reference to the object whose facet will be removed.
	//
	// This member is required.
	ObjectReference *ObjectReference

	// The facet to remove from the object.
	//
	// This member is required.
	SchemaFacet *SchemaFacet
	// contains filtered or unexported fields
}

A batch operation to remove a facet from an object.

type BatchRemoveFacetFromObjectResponse 

type BatchRemoveFacetFromObjectResponse struct {
	// contains filtered or unexported fields
}

An empty result that represents success.

type BatchUpdateLinkAttributes 

type BatchUpdateLinkAttributes struct {

	// The attributes update structure.
	//
	// This member is required.
	AttributeUpdates []LinkAttributeUpdate

	// Allows a typed link specifier to be accepted as input.
	//
	// This member is required.
	TypedLinkSpecifier *TypedLinkSpecifier
	// contains filtered or unexported fields
}

Updates a given typed link’s attributes inside a BatchRead operation. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder . For more information, see UpdateLinkAttributes and BatchReadRequest$Operations .

type BatchUpdateLinkAttributesResponse 

type BatchUpdateLinkAttributesResponse struct {
	// contains filtered or unexported fields
}

Represents the output of a UpdateLinkAttributes response operation.

type BatchUpdateObjectAttributes 

type BatchUpdateObjectAttributes struct {

	// Attributes update structure.
	//
	// This member is required.
	AttributeUpdates []ObjectAttributeUpdate

	// Reference that identifies the object.
	//
	// This member is required.
	ObjectReference *ObjectReference
	// contains filtered or unexported fields
}

Represents the output of a BatchUpdate operation.

type BatchUpdateObjectAttributesResponse 

type BatchUpdateObjectAttributesResponse struct {

	// ID that is associated with the object.
	ObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents the output of a BatchUpdate response operation.

type BatchWriteException 

type BatchWriteException struct {
	Message *string

	ErrorCodeOverride *string

	Index int32
	Type  BatchWriteExceptionType
	// contains filtered or unexported fields
}

A BatchWrite exception has occurred.

func (*BatchWriteException) Error 

func (e *BatchWriteException) Error() string

func (*BatchWriteException) ErrorCode 

func (e *BatchWriteException) ErrorCode() string

func (*BatchWriteException) ErrorFault 

func (e *BatchWriteException) ErrorFault() smithy.ErrorFault

func (*BatchWriteException) ErrorMessage 

func (e *BatchWriteException) ErrorMessage() string

type BatchWriteExceptionType 

type BatchWriteExceptionType string
const (
	BatchWriteExceptionTypeInternalServiceException         BatchWriteExceptionType = "InternalServiceException"
	BatchWriteExceptionTypeValidationException              BatchWriteExceptionType = "ValidationException"
	BatchWriteExceptionTypeInvalidArnException              BatchWriteExceptionType = "InvalidArnException"
	BatchWriteExceptionTypeLinkNameAlreadyInUseException    BatchWriteExceptionType = "LinkNameAlreadyInUseException"
	BatchWriteExceptionTypeStillContainsLinksException      BatchWriteExceptionType = "StillContainsLinksException"
	BatchWriteExceptionTypeFacetValidationException         BatchWriteExceptionType = "FacetValidationException"
	BatchWriteExceptionTypeObjectNotDetachedException       BatchWriteExceptionType = "ObjectNotDetachedException"
	BatchWriteExceptionTypeResourceNotFoundException        BatchWriteExceptionType = "ResourceNotFoundException"
	BatchWriteExceptionTypeAccessDeniedException            BatchWriteExceptionType = "AccessDeniedException"
	BatchWriteExceptionTypeInvalidAttachmentException       BatchWriteExceptionType = "InvalidAttachmentException"
	BatchWriteExceptionTypeNotIndexException                BatchWriteExceptionType = "NotIndexException"
	BatchWriteExceptionTypeNotNodeException                 BatchWriteExceptionType = "NotNodeException"
	BatchWriteExceptionTypeIndexedAttributeMissingException BatchWriteExceptionType = "IndexedAttributeMissingException"
	BatchWriteExceptionTypeObjectAlreadyDetachedException   BatchWriteExceptionType = "ObjectAlreadyDetachedException"
	BatchWriteExceptionTypeNotPolicyException               BatchWriteExceptionType = "NotPolicyException"
	BatchWriteExceptionTypeDirectoryNotEnabledException     BatchWriteExceptionType = "DirectoryNotEnabledException"
	BatchWriteExceptionTypeLimitExceededException           BatchWriteExceptionType = "LimitExceededException"
	BatchWriteExceptionTypeUnsupportedIndexTypeException    BatchWriteExceptionType = "UnsupportedIndexTypeException"
)

Enum values for BatchWriteExceptionType

func (BatchWriteExceptionType) Values added in v0.29.0 

func (BatchWriteExceptionType) Values() []BatchWriteExceptionType

Values returns all known values for BatchWriteExceptionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type BatchWriteOperation 

type BatchWriteOperation struct {

	// A batch operation that adds a facet to an object.
	AddFacetToObject *BatchAddFacetToObject

	// Attaches an object to a Directory .
	AttachObject *BatchAttachObject

	// Attaches a policy object to a regular object. An object can have a limited
	// number of attached policies.
	AttachPolicy *BatchAttachPolicy

	// Attaches the specified object to the specified index.
	AttachToIndex *BatchAttachToIndex

	// Attaches a typed link to a specified source and target object. For more
	// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	AttachTypedLink *BatchAttachTypedLink

	// Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm)
	// for more information.
	CreateIndex *BatchCreateIndex

	// Creates an object.
	CreateObject *BatchCreateObject

	// Deletes an object in a Directory .
	DeleteObject *BatchDeleteObject

	// Detaches the specified object from the specified index.
	DetachFromIndex *BatchDetachFromIndex

	// Detaches an object from a Directory .
	DetachObject *BatchDetachObject

	// Detaches a policy from a Directory .
	DetachPolicy *BatchDetachPolicy

	// Detaches a typed link from a specified source and target object. For more
	// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	DetachTypedLink *BatchDetachTypedLink

	// A batch operation that removes a facet from an object.
	RemoveFacetFromObject *BatchRemoveFacetFromObject

	// Updates a given object's attributes.
	UpdateLinkAttributes *BatchUpdateLinkAttributes

	// Updates a given object's attributes.
	UpdateObjectAttributes *BatchUpdateObjectAttributes
	// contains filtered or unexported fields
}

Represents the output of a BatchWrite operation.

type BatchWriteOperationResponse 

type BatchWriteOperationResponse struct {

	// The result of an add facet to object batch operation.
	AddFacetToObject *BatchAddFacetToObjectResponse

	// Attaches an object to a Directory .
	AttachObject *BatchAttachObjectResponse

	// Attaches a policy object to a regular object. An object can have a limited
	// number of attached policies.
	AttachPolicy *BatchAttachPolicyResponse

	// Attaches the specified object to the specified index.
	AttachToIndex *BatchAttachToIndexResponse

	// Attaches a typed link to a specified source and target object. For more
	// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	AttachTypedLink *BatchAttachTypedLinkResponse

	// Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.htm)
	// for more information.
	CreateIndex *BatchCreateIndexResponse

	// Creates an object in a Directory .
	CreateObject *BatchCreateObjectResponse

	// Deletes an object in a Directory .
	DeleteObject *BatchDeleteObjectResponse

	// Detaches the specified object from the specified index.
	DetachFromIndex *BatchDetachFromIndexResponse

	// Detaches an object from a Directory .
	DetachObject *BatchDetachObjectResponse

	// Detaches a policy from a Directory .
	DetachPolicy *BatchDetachPolicyResponse

	// Detaches a typed link from a specified source and target object. For more
	// information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink)
	// .
	DetachTypedLink *BatchDetachTypedLinkResponse

	// The result of a batch remove facet from object operation.
	RemoveFacetFromObject *BatchRemoveFacetFromObjectResponse

	// Represents the output of a BatchWrite response operation.
	UpdateLinkAttributes *BatchUpdateLinkAttributesResponse

	// Updates a given object’s attributes.
	UpdateObjectAttributes *BatchUpdateObjectAttributesResponse
	// contains filtered or unexported fields
}

Represents the output of a BatchWrite response operation.

type CannotListParentOfRootException 

type CannotListParentOfRootException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Cannot list the parents of a Directory root.

func (*CannotListParentOfRootException) Error 

func (e *CannotListParentOfRootException) Error() string

func (*CannotListParentOfRootException) ErrorCode 

func (e *CannotListParentOfRootException) ErrorCode() string

func (*CannotListParentOfRootException) ErrorFault 

func (e *CannotListParentOfRootException) ErrorFault() smithy.ErrorFault

func (*CannotListParentOfRootException) ErrorMessage 

func (e *CannotListParentOfRootException) ErrorMessage() string

type ConsistencyLevel 

type ConsistencyLevel string
const (
	ConsistencyLevelSerializable ConsistencyLevel = "SERIALIZABLE"
	ConsistencyLevelEventual     ConsistencyLevel = "EVENTUAL"
)

Enum values for ConsistencyLevel

func (ConsistencyLevel) Values added in v0.29.0 

func (ConsistencyLevel) Values() []ConsistencyLevel

Values returns all known values for ConsistencyLevel. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Directory 

type Directory struct {

	// The date and time when the directory was created.
	CreationDateTime *time.Time

	// The Amazon Resource Name (ARN) that is associated with the directory. For more
	// information, see arns .
	DirectoryArn *string

	// The name of the directory.
	Name *string

	// The state of the directory. Can be either Enabled , Disabled , or Deleted .
	State DirectoryState
	// contains filtered or unexported fields
}

Directory structure that includes the directory name and directory ARN.

type DirectoryAlreadyExistsException 

type DirectoryAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a Directory could not be created due to a naming conflict. Choose a different name and try again.

func (*DirectoryAlreadyExistsException) Error 

func (e *DirectoryAlreadyExistsException) Error() string

func (*DirectoryAlreadyExistsException) ErrorCode 

func (e *DirectoryAlreadyExistsException) ErrorCode() string

func (*DirectoryAlreadyExistsException) ErrorFault 

func (e *DirectoryAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*DirectoryAlreadyExistsException) ErrorMessage 

func (e *DirectoryAlreadyExistsException) ErrorMessage() string

type DirectoryDeletedException 

type DirectoryDeletedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A directory that has been deleted and to which access has been attempted. Note: The requested resource will eventually cease to exist.

func (*DirectoryDeletedException) Error 

func (e *DirectoryDeletedException) Error() string

func (*DirectoryDeletedException) ErrorCode 

func (e *DirectoryDeletedException) ErrorCode() string

func (*DirectoryDeletedException) ErrorFault 

func (e *DirectoryDeletedException) ErrorFault() smithy.ErrorFault

func (*DirectoryDeletedException) ErrorMessage 

func (e *DirectoryDeletedException) ErrorMessage() string

type DirectoryNotDisabledException 

type DirectoryNotDisabledException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An operation can only operate on a disabled directory.

func (*DirectoryNotDisabledException) Error 

func (e *DirectoryNotDisabledException) Error() string

func (*DirectoryNotDisabledException) ErrorCode 

func (e *DirectoryNotDisabledException) ErrorCode() string

func (*DirectoryNotDisabledException) ErrorFault 

func (e *DirectoryNotDisabledException) ErrorFault() smithy.ErrorFault

func (*DirectoryNotDisabledException) ErrorMessage 

func (e *DirectoryNotDisabledException) ErrorMessage() string

type DirectoryNotEnabledException 

type DirectoryNotEnabledException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Operations are only permitted on enabled directories.

func (*DirectoryNotEnabledException) Error 

func (e *DirectoryNotEnabledException) Error() string

func (*DirectoryNotEnabledException) ErrorCode 

func (e *DirectoryNotEnabledException) ErrorCode() string

func (*DirectoryNotEnabledException) ErrorFault 

func (e *DirectoryNotEnabledException) ErrorFault() smithy.ErrorFault

func (*DirectoryNotEnabledException) ErrorMessage 

func (e *DirectoryNotEnabledException) ErrorMessage() string

type DirectoryState 

type DirectoryState string
const (
	DirectoryStateEnabled  DirectoryState = "ENABLED"
	DirectoryStateDisabled DirectoryState = "DISABLED"
	DirectoryStateDeleted  DirectoryState = "DELETED"
)

Enum values for DirectoryState

func (DirectoryState) Values added in v0.29.0 

func (DirectoryState) Values() []DirectoryState

Values returns all known values for DirectoryState. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type Facet 

type Facet struct {

	// 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.
	FacetStyle FacetStyle

	// The name of the Facet .
	Name *string

	// The object type that is associated with the facet. See
	// CreateFacetRequest$ObjectType for more details.
	ObjectType ObjectType
	// contains filtered or unexported fields
}

A structure that contains Name , ARN , Attributes , Rule s , and ObjectTypes . See Facets (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_whatarefacets.html) for more information.

type FacetAlreadyExistsException 

type FacetAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

A facet with the same name already exists.

func (*FacetAlreadyExistsException) Error 

func (e *FacetAlreadyExistsException) Error() string

func (*FacetAlreadyExistsException) ErrorCode 

func (e *FacetAlreadyExistsException) ErrorCode() string

func (*FacetAlreadyExistsException) ErrorFault 

func (e *FacetAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*FacetAlreadyExistsException) ErrorMessage 

func (e *FacetAlreadyExistsException) ErrorMessage() string

type FacetAttribute 

type FacetAttribute struct {

	// The name of the facet attribute.
	//
	// This member is required.
	Name *string

	// A facet attribute consists of either a definition or a reference. This
	// structure contains the attribute definition. See Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html)
	// for more information.
	AttributeDefinition *FacetAttributeDefinition

	// An attribute reference that is associated with the attribute. See Attribute
	// References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html)
	// for more information.
	AttributeReference *FacetAttributeReference

	// The required behavior of the FacetAttribute .
	RequiredBehavior RequiredAttributeBehavior
	// contains filtered or unexported fields
}

An attribute that is associated with the Facet .

type FacetAttributeDefinition 

type FacetAttributeDefinition struct {

	// The type of the attribute.
	//
	// This member is required.
	Type FacetAttributeType

	// The default value of the attribute (if configured).
	DefaultValue TypedAttributeValue

	// Whether the attribute is mutable or not.
	IsImmutable bool

	// Validation rules attached to the attribute definition.
	Rules map[string]Rule
	// contains filtered or unexported fields
}

A facet attribute definition. See Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html) for more information.

type FacetAttributeReference 

type FacetAttributeReference struct {

	// The target attribute name that is associated with the facet reference. See
	// Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html)
	// for more information.
	//
	// This member is required.
	TargetAttributeName *string

	// The target facet name that is associated with the facet reference. See
	// Attribute References (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_attributereferences.html)
	// for more information.
	//
	// This member is required.
	TargetFacetName *string
	// contains filtered or unexported fields
}

The facet attribute reference that specifies the attribute definition that contains the attribute facet name and attribute name.

type FacetAttributeType 

type FacetAttributeType string
const (
	FacetAttributeTypeString   FacetAttributeType = "STRING"
	FacetAttributeTypeBinary   FacetAttributeType = "BINARY"
	FacetAttributeTypeBoolean  FacetAttributeType = "BOOLEAN"
	FacetAttributeTypeNumber   FacetAttributeType = "NUMBER"
	FacetAttributeTypeDatetime FacetAttributeType = "DATETIME"
	FacetAttributeTypeVariant  FacetAttributeType = "VARIANT"
)

Enum values for FacetAttributeType

func (FacetAttributeType) Values added in v0.29.0 

func (FacetAttributeType) Values() []FacetAttributeType

Values returns all known values for FacetAttributeType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FacetAttributeUpdate 

type FacetAttributeUpdate struct {

	// The action to perform when updating the attribute.
	Action UpdateActionType

	// The attribute to update.
	Attribute *FacetAttribute
	// contains filtered or unexported fields
}

A structure that contains information used to update an attribute.

type FacetInUseException 

type FacetInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a different facet.

func (*FacetInUseException) Error 

func (e *FacetInUseException) Error() string

func (*FacetInUseException) ErrorCode 

func (e *FacetInUseException) ErrorCode() string

func (*FacetInUseException) ErrorFault 

func (e *FacetInUseException) ErrorFault() smithy.ErrorFault

func (*FacetInUseException) ErrorMessage 

func (e *FacetInUseException) ErrorMessage() string

type FacetNotFoundException 

type FacetNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified Facet could not be found.

func (*FacetNotFoundException) Error 

func (e *FacetNotFoundException) Error() string

func (*FacetNotFoundException) ErrorCode 

func (e *FacetNotFoundException) ErrorCode() string

func (*FacetNotFoundException) ErrorFault 

func (e *FacetNotFoundException) ErrorFault() smithy.ErrorFault

func (*FacetNotFoundException) ErrorMessage 

func (e *FacetNotFoundException) ErrorMessage() string

type FacetStyle 

type FacetStyle string
const (
	FacetStyleStatic  FacetStyle = "STATIC"
	FacetStyleDynamic FacetStyle = "DYNAMIC"
)

Enum values for FacetStyle

func (FacetStyle) Values added in v0.29.0 

func (FacetStyle) Values() []FacetStyle

Values returns all known values for FacetStyle. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type FacetValidationException 

type FacetValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The Facet that you provided was not well formed or could not be validated with the schema.

func (*FacetValidationException) Error 

func (e *FacetValidationException) Error() string

func (*FacetValidationException) ErrorCode 

func (e *FacetValidationException) ErrorCode() string

func (*FacetValidationException) ErrorFault 

func (e *FacetValidationException) ErrorFault() smithy.ErrorFault

func (*FacetValidationException) ErrorMessage 

func (e *FacetValidationException) ErrorMessage() string

type IncompatibleSchemaException 

type IncompatibleSchemaException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*IncompatibleSchemaException) Error 

func (e *IncompatibleSchemaException) Error() string

func (*IncompatibleSchemaException) ErrorCode 

func (e *IncompatibleSchemaException) ErrorCode() string

func (*IncompatibleSchemaException) ErrorFault 

func (e *IncompatibleSchemaException) ErrorFault() smithy.ErrorFault

func (*IncompatibleSchemaException) ErrorMessage 

func (e *IncompatibleSchemaException) ErrorMessage() string

type IndexAttachment 

type IndexAttachment struct {

	// The indexed attribute values.
	IndexedAttributes []AttributeKeyAndValue

	// 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.
	ObjectIdentifier *string
	// contains filtered or unexported fields
}

Represents an index and an attached object.

type IndexedAttributeMissingException 

type IndexedAttributeMissingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An object has been attempted to be attached to an object that does not have the appropriate attribute value.

func (*IndexedAttributeMissingException) Error 

func (e *IndexedAttributeMissingException) Error() string

func (*IndexedAttributeMissingException) ErrorCode 

func (e *IndexedAttributeMissingException) ErrorCode() string

func (*IndexedAttributeMissingException) ErrorFault 

func (e *IndexedAttributeMissingException) ErrorFault() smithy.ErrorFault

func (*IndexedAttributeMissingException) ErrorMessage 

func (e *IndexedAttributeMissingException) ErrorMessage() string

type InternalServiceException 

type InternalServiceException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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 (http://status.aws.amazon.com/) site to see if there are any operational issues with the service.

func (*InternalServiceException) Error 

func (e *InternalServiceException) Error() string

func (*InternalServiceException) ErrorCode 

func (e *InternalServiceException) ErrorCode() string

func (*InternalServiceException) ErrorFault 

func (e *InternalServiceException) ErrorFault() smithy.ErrorFault

func (*InternalServiceException) ErrorMessage 

func (e *InternalServiceException) ErrorMessage() string

type InvalidArnException 

type InvalidArnException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the provided ARN value is not valid.

func (*InvalidArnException) Error 

func (e *InvalidArnException) Error() string

func (*InvalidArnException) ErrorCode 

func (e *InvalidArnException) ErrorCode() string

func (*InvalidArnException) ErrorFault 

func (e *InvalidArnException) ErrorFault() smithy.ErrorFault

func (*InvalidArnException) ErrorMessage 

func (e *InvalidArnException) ErrorMessage() string

type InvalidAttachmentException 

type InvalidAttachmentException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that an attempt to make an attachment was invalid. For example, attaching two nodes with a link type that is not applicable to the nodes or attempting to apply a schema to a directory a second time.

func (*InvalidAttachmentException) Error 

func (e *InvalidAttachmentException) Error() string

func (*InvalidAttachmentException) ErrorCode 

func (e *InvalidAttachmentException) ErrorCode() string

func (*InvalidAttachmentException) ErrorFault 

func (e *InvalidAttachmentException) ErrorFault() smithy.ErrorFault

func (*InvalidAttachmentException) ErrorMessage 

func (e *InvalidAttachmentException) ErrorMessage() string

type InvalidFacetUpdateException 

type InvalidFacetUpdateException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

An attempt to modify a Facet resulted in an invalid schema exception.

func (*InvalidFacetUpdateException) Error 

func (e *InvalidFacetUpdateException) Error() string

func (*InvalidFacetUpdateException) ErrorCode 

func (e *InvalidFacetUpdateException) ErrorCode() string

func (*InvalidFacetUpdateException) ErrorFault 

func (e *InvalidFacetUpdateException) ErrorFault() smithy.ErrorFault

func (*InvalidFacetUpdateException) ErrorMessage 

func (e *InvalidFacetUpdateException) ErrorMessage() string

type InvalidNextTokenException 

type InvalidNextTokenException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the NextToken value is not valid.

func (*InvalidNextTokenException) Error 

func (e *InvalidNextTokenException) Error() string

func (*InvalidNextTokenException) ErrorCode 

func (e *InvalidNextTokenException) ErrorCode() string

func (*InvalidNextTokenException) ErrorFault 

func (e *InvalidNextTokenException) ErrorFault() smithy.ErrorFault

func (*InvalidNextTokenException) ErrorMessage 

func (e *InvalidNextTokenException) ErrorMessage() string

type InvalidRuleException 

type InvalidRuleException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Occurs when any of the rule parameter keys or values are invalid.

func (*InvalidRuleException) Error 

func (e *InvalidRuleException) Error() string

func (*InvalidRuleException) ErrorCode 

func (e *InvalidRuleException) ErrorCode() string

func (*InvalidRuleException) ErrorFault 

func (e *InvalidRuleException) ErrorFault() smithy.ErrorFault

func (*InvalidRuleException) ErrorMessage 

func (e *InvalidRuleException) ErrorMessage() string

type InvalidSchemaDocException 

type InvalidSchemaDocException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the provided SchemaDoc value is not valid.

func (*InvalidSchemaDocException) Error 

func (e *InvalidSchemaDocException) Error() string

func (*InvalidSchemaDocException) ErrorCode 

func (e *InvalidSchemaDocException) ErrorCode() string

func (*InvalidSchemaDocException) ErrorFault 

func (e *InvalidSchemaDocException) ErrorFault() smithy.ErrorFault

func (*InvalidSchemaDocException) ErrorMessage 

func (e *InvalidSchemaDocException) ErrorMessage() string

type InvalidTaggingRequestException 

type InvalidTaggingRequestException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

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.

func (*InvalidTaggingRequestException) Error 

func (e *InvalidTaggingRequestException) Error() string

func (*InvalidTaggingRequestException) ErrorCode 

func (e *InvalidTaggingRequestException) ErrorCode() string

func (*InvalidTaggingRequestException) ErrorFault 

func (e *InvalidTaggingRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidTaggingRequestException) ErrorMessage 

func (e *InvalidTaggingRequestException) ErrorMessage() string

type LimitExceededException 

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that limits are exceeded. See Limits (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html) for more information.

func (*LimitExceededException) Error 

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode 

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault 

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage 

func (e *LimitExceededException) ErrorMessage() string

type LinkAttributeAction 

type LinkAttributeAction struct {

	// A type that can be either UPDATE_OR_CREATE or DELETE .
	AttributeActionType UpdateActionType

	// The value that you want to update to.
	AttributeUpdateValue TypedAttributeValue
	// contains filtered or unexported fields
}

The action to take on a typed link attribute value. Updates are only supported for attributes which don’t contribute to link identity.

type LinkAttributeUpdate 

type LinkAttributeUpdate struct {

	// The action to perform as part of the attribute update.
	AttributeAction *LinkAttributeAction

	// The key of the attribute being updated.
	AttributeKey *AttributeKey
	// contains filtered or unexported fields
}

Structure that contains attribute update information.

type LinkNameAlreadyInUseException 

type LinkNameAlreadyInUseException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a link could not be created due to a naming conflict. Choose a different name and then try again.

func (*LinkNameAlreadyInUseException) Error 

func (e *LinkNameAlreadyInUseException) Error() string

func (*LinkNameAlreadyInUseException) ErrorCode 

func (e *LinkNameAlreadyInUseException) ErrorCode() string

func (*LinkNameAlreadyInUseException) ErrorFault 

func (e *LinkNameAlreadyInUseException) ErrorFault() smithy.ErrorFault

func (*LinkNameAlreadyInUseException) ErrorMessage 

func (e *LinkNameAlreadyInUseException) ErrorMessage() string

type NotIndexException 

type NotIndexException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the requested operation can only operate on index objects.

func (*NotIndexException) Error 

func (e *NotIndexException) Error() string

func (*NotIndexException) ErrorCode 

func (e *NotIndexException) ErrorCode() string

func (*NotIndexException) ErrorFault 

func (e *NotIndexException) ErrorFault() smithy.ErrorFault

func (*NotIndexException) ErrorMessage 

func (e *NotIndexException) ErrorMessage() string

type NotNodeException 

type NotNodeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Occurs when any invalid operations are performed on an object that is not a node, such as calling ListObjectChildren for a leaf node object.

func (*NotNodeException) Error 

func (e *NotNodeException) Error() string

func (*NotNodeException) ErrorCode 

func (e *NotNodeException) ErrorCode() string

func (*NotNodeException) ErrorFault 

func (e *NotNodeException) ErrorFault() smithy.ErrorFault

func (*NotNodeException) ErrorMessage 

func (e *NotNodeException) ErrorMessage() string

type NotPolicyException 

type NotPolicyException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the requested operation can only operate on policy objects.

func (*NotPolicyException) Error 

func (e *NotPolicyException) Error() string

func (*NotPolicyException) ErrorCode 

func (e *NotPolicyException) ErrorCode() string

func (*NotPolicyException) ErrorFault 

func (e *NotPolicyException) ErrorFault() smithy.ErrorFault

func (*NotPolicyException) ErrorMessage 

func (e *NotPolicyException) ErrorMessage() string

type ObjectAlreadyDetachedException 

type ObjectAlreadyDetachedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the object is not attached to the index.

func (*ObjectAlreadyDetachedException) Error 

func (e *ObjectAlreadyDetachedException) Error() string

func (*ObjectAlreadyDetachedException) ErrorCode 

func (e *ObjectAlreadyDetachedException) ErrorCode() string

func (*ObjectAlreadyDetachedException) ErrorFault 

func (e *ObjectAlreadyDetachedException) ErrorFault() smithy.ErrorFault

func (*ObjectAlreadyDetachedException) ErrorMessage 

func (e *ObjectAlreadyDetachedException) ErrorMessage() string

type ObjectAttributeAction 

type ObjectAttributeAction struct {

	// A type that can be either Update or Delete .
	ObjectAttributeActionType UpdateActionType

	// The value that you want to update to.
	ObjectAttributeUpdateValue TypedAttributeValue
	// contains filtered or unexported fields
}

The action to take on the object attribute.

type ObjectAttributeRange 

type ObjectAttributeRange struct {

	// The key of the attribute that the attribute range covers.
	AttributeKey *AttributeKey

	// The range of attribute values being selected.
	Range *TypedAttributeValueRange
	// contains filtered or unexported fields
}

A range of attributes.

type ObjectAttributeUpdate 

type ObjectAttributeUpdate struct {

	// The action to perform as part of the attribute update.
	ObjectAttributeAction *ObjectAttributeAction

	// The key of the attribute being updated.
	ObjectAttributeKey *AttributeKey
	// contains filtered or unexported fields
}

Structure that contains attribute update information.

type ObjectIdentifierAndLinkNameTuple 

type ObjectIdentifierAndLinkNameTuple struct {

	// The name of the link between the parent and the child object.
	LinkName *string

	// The ID that is associated with the object.
	ObjectIdentifier *string
	// contains filtered or unexported fields
}

A pair of ObjectIdentifier and LinkName.

type ObjectNotDetachedException 

type ObjectNotDetachedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the requested operation cannot be completed because the object has not been detached from the tree.

func (*ObjectNotDetachedException) Error 

func (e *ObjectNotDetachedException) Error() string

func (*ObjectNotDetachedException) ErrorCode 

func (e *ObjectNotDetachedException) ErrorCode() string

func (*ObjectNotDetachedException) ErrorFault 

func (e *ObjectNotDetachedException) ErrorFault() smithy.ErrorFault

func (*ObjectNotDetachedException) ErrorMessage 

func (e *ObjectNotDetachedException) ErrorMessage() string

type ObjectReference 

type ObjectReference struct {

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_access_objects.html)
	// . 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
	Selector *string
	// contains filtered or unexported fields
}

The reference that identifies an object.

type ObjectType 

type ObjectType string
const (
	ObjectTypeNode     ObjectType = "NODE"
	ObjectTypeLeafNode ObjectType = "LEAF_NODE"
	ObjectTypePolicy   ObjectType = "POLICY"
	ObjectTypeIndex    ObjectType = "INDEX"
)

Enum values for ObjectType

func (ObjectType) Values added in v0.29.0 

func (ObjectType) Values() []ObjectType

Values returns all known values for ObjectType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type PathToObjectIdentifiers 

type PathToObjectIdentifiers struct {

	// Lists ObjectIdentifiers starting from directory root to the object in the
	// request.
	ObjectIdentifiers []string

	// The path that is used to identify the object starting from directory root.
	Path *string
	// contains filtered or unexported fields
}

Returns the path to the ObjectIdentifiers that is associated with the directory.

type PolicyAttachment 

type PolicyAttachment struct {

	// The ObjectIdentifier that is associated with PolicyAttachment .
	ObjectIdentifier *string

	// The ID of PolicyAttachment .
	PolicyId *string

	// The type of policy that can be associated with PolicyAttachment .
	PolicyType *string
	// contains filtered or unexported fields
}

Contains the PolicyType , PolicyId , and the ObjectIdentifier to which it is attached. For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies) .

type PolicyToPath 

type PolicyToPath struct {

	// The path that is referenced from the root.
	Path *string

	// List of policy objects.
	Policies []PolicyAttachment
	// contains filtered or unexported fields
}

Used when a regular object exists in a Directory and you want to find all of the policies that are associated with that object and the parent to that object.

type RangeMode 

type RangeMode string
const (
	RangeModeFirst                   RangeMode = "FIRST"
	RangeModeLast                    RangeMode = "LAST"
	RangeModeLastBeforeMissingValues RangeMode = "LAST_BEFORE_MISSING_VALUES"
	RangeModeInclusive               RangeMode = "INCLUSIVE"
	RangeModeExclusive               RangeMode = "EXCLUSIVE"
)

Enum values for RangeMode

func (RangeMode) Values added in v0.29.0 

func (RangeMode) Values() []RangeMode

Values returns all known values for RangeMode. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type RequiredAttributeBehavior 

type RequiredAttributeBehavior string
const (
	RequiredAttributeBehaviorRequiredAlways RequiredAttributeBehavior = "REQUIRED_ALWAYS"
	RequiredAttributeBehaviorNotRequired    RequiredAttributeBehavior = "NOT_REQUIRED"
)

Enum values for RequiredAttributeBehavior

func (RequiredAttributeBehavior) Values added in v0.29.0 

func (RequiredAttributeBehavior) Values() []RequiredAttributeBehavior

Values returns all known values for RequiredAttributeBehavior. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The specified resource could not be found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type RetryableConflictException 

type RetryableConflictException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Occurs when a conflict with a previous successful write is detected. For example, if a write operation occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this exception may result. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

func (*RetryableConflictException) Error 

func (e *RetryableConflictException) Error() string

func (*RetryableConflictException) ErrorCode 

func (e *RetryableConflictException) ErrorCode() string

func (*RetryableConflictException) ErrorFault 

func (e *RetryableConflictException) ErrorFault() smithy.ErrorFault

func (*RetryableConflictException) ErrorMessage 

func (e *RetryableConflictException) ErrorMessage() string

type Rule 

type Rule struct {

	// The minimum and maximum parameters that are associated with the rule.
	Parameters map[string]string

	// The type of attribute validation rule.
	Type RuleType
	// contains filtered or unexported fields
}

Contains an Amazon Resource Name (ARN) and parameters that are associated with the rule.

type RuleType 

type RuleType string
const (
	RuleTypeBinaryLength     RuleType = "BINARY_LENGTH"
	RuleTypeNumberComparison RuleType = "NUMBER_COMPARISON"
	RuleTypeStringFromSet    RuleType = "STRING_FROM_SET"
	RuleTypeStringLength     RuleType = "STRING_LENGTH"
)

Enum values for RuleType

func (RuleType) Values added in v0.29.0 

func (RuleType) Values() []RuleType

Values returns all known values for RuleType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type SchemaAlreadyExistsException 

type SchemaAlreadyExistsException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a schema could not be created due to a naming conflict. Please select a different name and then try again.

func (*SchemaAlreadyExistsException) Error 

func (e *SchemaAlreadyExistsException) Error() string

func (*SchemaAlreadyExistsException) ErrorCode 

func (e *SchemaAlreadyExistsException) ErrorCode() string

func (*SchemaAlreadyExistsException) ErrorFault 

func (e *SchemaAlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*SchemaAlreadyExistsException) ErrorMessage 

func (e *SchemaAlreadyExistsException) ErrorMessage() string

type SchemaAlreadyPublishedException 

type SchemaAlreadyPublishedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that a schema is already published.

func (*SchemaAlreadyPublishedException) Error 

func (e *SchemaAlreadyPublishedException) Error() string

func (*SchemaAlreadyPublishedException) ErrorCode 

func (e *SchemaAlreadyPublishedException) ErrorCode() string

func (*SchemaAlreadyPublishedException) ErrorFault 

func (e *SchemaAlreadyPublishedException) ErrorFault() smithy.ErrorFault

func (*SchemaAlreadyPublishedException) ErrorMessage 

func (e *SchemaAlreadyPublishedException) ErrorMessage() string

type SchemaFacet 

type SchemaFacet struct {

	// The name of the facet. If this value is set, SchemaArn must also be set.
	FacetName *string

	// The ARN of the schema that contains the facet with no minor component. See arns
	// and In-Place Schema Upgrade (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_inplaceschemaupgrade.html)
	// for a description of when to provide minor versions. If this value is set,
	// FacetName must also be set.
	SchemaArn *string
	// contains filtered or unexported fields
}

A facet.

type StillContainsLinksException 

type StillContainsLinksException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The object could not be deleted because links still exist. Remove the links and then try the operation again.

func (*StillContainsLinksException) Error 

func (e *StillContainsLinksException) Error() string

func (*StillContainsLinksException) ErrorCode 

func (e *StillContainsLinksException) ErrorCode() string

func (*StillContainsLinksException) ErrorFault 

func (e *StillContainsLinksException) ErrorFault() smithy.ErrorFault

func (*StillContainsLinksException) ErrorMessage 

func (e *StillContainsLinksException) ErrorMessage() string

type Tag 

type Tag struct {

	// The key that is associated with the tag.
	Key *string

	// The value that is associated with the tag.
	Value *string
	// contains filtered or unexported fields
}

The tag structure that contains a tag key and value.

type TypedAttributeValue 

type TypedAttributeValue interface {
	// contains filtered or unexported methods
}

Represents the data for a typed attribute. You can set one, and only one, of the elements. Each attribute in an item is a name-value pair. Attributes have a single value.

The following types satisfy this interface: 

TypedAttributeValueMemberBinaryValue
TypedAttributeValueMemberBooleanValue
TypedAttributeValueMemberDatetimeValue
TypedAttributeValueMemberNumberValue
TypedAttributeValueMemberStringValue
Example (OutputUsage) 
// Code generated by smithy-go-codegen DO NOT EDIT.

package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/clouddirectory/types"
	"time"
)

func main() {
	var union types.TypedAttributeValue
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.TypedAttributeValueMemberBinaryValue:
		_ = v.Value // Value is []byte

	case *types.TypedAttributeValueMemberBooleanValue:
		_ = v.Value // Value is bool

	case *types.TypedAttributeValueMemberDatetimeValue:
		_ = v.Value // Value is time.Time

	case *types.TypedAttributeValueMemberNumberValue:
		_ = v.Value // Value is string

	case *types.TypedAttributeValueMemberStringValue:
		_ = v.Value // Value is string

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

var _ *string
var _ *string
var _ *bool
var _ *time.Time
var _ []byte

Output:

type TypedAttributeValueMemberBinaryValue added in v0.31.0 

type TypedAttributeValueMemberBinaryValue struct {
	Value []byte
	// contains filtered or unexported fields
}

A binary data value.

type TypedAttributeValueMemberBooleanValue added in v0.31.0 

type TypedAttributeValueMemberBooleanValue struct {
	Value bool
	// contains filtered or unexported fields
}

A Boolean data value.

type TypedAttributeValueMemberDatetimeValue added in v0.31.0 

type TypedAttributeValueMemberDatetimeValue struct {
	Value time.Time
	// contains filtered or unexported fields
}

A date and time value.

type TypedAttributeValueMemberNumberValue added in v0.31.0 

type TypedAttributeValueMemberNumberValue struct {
	Value string
	// contains filtered or unexported fields
}

A number data value.

type TypedAttributeValueMemberStringValue added in v0.31.0 

type TypedAttributeValueMemberStringValue struct {
	Value string
	// contains filtered or unexported fields
}

A string data value.

type TypedAttributeValueRange 

type TypedAttributeValueRange struct {

	// The inclusive or exclusive range end.
	//
	// This member is required.
	EndMode RangeMode

	// The inclusive or exclusive range start.
	//
	// This member is required.
	StartMode RangeMode

	// The attribute value to terminate the range at.
	EndValue TypedAttributeValue

	// The value to start the range at.
	StartValue TypedAttributeValue
	// contains filtered or unexported fields
}

A range of attribute values. For more information, see Range Filters (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_range_filters.html) .

type TypedLinkAttributeDefinition 

type TypedLinkAttributeDefinition struct {

	// The unique name of the typed link attribute.
	//
	// This member is required.
	Name *string

	// The required behavior of the TypedLinkAttributeDefinition .
	//
	// This member is required.
	RequiredBehavior RequiredAttributeBehavior

	// The type of the attribute.
	//
	// This member is required.
	Type FacetAttributeType

	// The default value of the attribute (if configured).
	DefaultValue TypedAttributeValue

	// Whether the attribute is mutable or not.
	IsImmutable bool

	// Validation rules that are attached to the attribute definition.
	Rules map[string]Rule
	// contains filtered or unexported fields
}

A typed link attribute definition.

type TypedLinkAttributeRange 

type TypedLinkAttributeRange struct {

	// The range of attribute values that are being selected.
	//
	// This member is required.
	Range *TypedAttributeValueRange

	// The unique name of the typed link attribute.
	AttributeName *string
	// contains filtered or unexported fields
}

Identifies the range of attributes that are used by a specified filter.

type TypedLinkFacet 

type TypedLinkFacet struct {

	// 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.
	//
	// This member is required.
	Attributes []TypedLinkAttributeDefinition

	// 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.
	//
	// This member is required.
	IdentityAttributeOrder []string

	// The unique name of the typed link facet.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Defines the typed links structure and its attributes. To create a typed link facet, use the CreateTypedLinkFacet API.

type TypedLinkFacetAttributeUpdate 

type TypedLinkFacetAttributeUpdate struct {

	// The action to perform when updating the attribute.
	//
	// This member is required.
	Action UpdateActionType

	// The attribute to update.
	//
	// This member is required.
	Attribute *TypedLinkAttributeDefinition
	// contains filtered or unexported fields
}

A typed link facet attribute update.

type TypedLinkSchemaAndFacetName 

type TypedLinkSchemaAndFacetName struct {

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns .
	//
	// This member is required.
	SchemaArn *string

	// The unique name of the typed link facet.
	//
	// This member is required.
	TypedLinkName *string
	// contains filtered or unexported fields
}

Identifies the schema Amazon Resource Name (ARN) and facet name for the typed link.

type TypedLinkSpecifier 

type TypedLinkSpecifier struct {

	// Identifies the attribute value to update.
	//
	// This member is required.
	IdentityAttributeValues []AttributeNameAndValue

	// Identifies the source object that the typed link will attach to.
	//
	// This member is required.
	SourceObjectReference *ObjectReference

	// Identifies the target object that the typed link will attach to.
	//
	// This member is required.
	TargetObjectReference *ObjectReference

	// Identifies the typed link facet that is associated with the typed link.
	//
	// This member is required.
	TypedLinkFacet *TypedLinkSchemaAndFacetName
	// contains filtered or unexported fields
}

Contains all the information that is used to uniquely identify a typed link. The parameters discussed in this topic are used to uniquely specify the typed link being operated on. The AttachTypedLink API returns a typed link specifier while the DetachTypedLink API accepts one as input. Similarly, the ListIncomingTypedLinks and ListOutgoingTypedLinks API operations provide typed link specifiers as output. You can also construct a typed link specifier from scratch.

type UnknownUnionMember added in v0.31.0 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type UnsupportedIndexTypeException 

type UnsupportedIndexTypeException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that the requested index type is not supported.

func (*UnsupportedIndexTypeException) Error 

func (e *UnsupportedIndexTypeException) Error() string

func (*UnsupportedIndexTypeException) ErrorCode 

func (e *UnsupportedIndexTypeException) ErrorCode() string

func (*UnsupportedIndexTypeException) ErrorFault 

func (e *UnsupportedIndexTypeException) ErrorFault() smithy.ErrorFault

func (*UnsupportedIndexTypeException) ErrorMessage 

func (e *UnsupportedIndexTypeException) ErrorMessage() string

type UpdateActionType 

type UpdateActionType string
const (
	UpdateActionTypeCreateOrUpdate UpdateActionType = "CREATE_OR_UPDATE"
	UpdateActionTypeDelete         UpdateActionType = "DELETE"
)

Enum values for UpdateActionType

func (UpdateActionType) Values added in v0.29.0 

func (UpdateActionType) Values() []UpdateActionType

Values returns all known values for UpdateActionType. Note that this can be expanded in the future, and so it is only as up to date as the client. The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

Indicates that your request is malformed in some manner. See the exception message.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.