clouddirectory

package
v1.23.14 Latest Latest
Warning

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

Go to latest
Published: Sep 3, 2019 License: Apache-2.0 Imports: 10 Imported by: 48

Documentation

Overview

Package clouddirectory provides the client and types for making API requests to Amazon CloudDirectory.

Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service (https://aws.amazon.com/directoryservice/) and the Amazon Cloud Directory Developer Guide (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html).

See https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11 for more information on this service.

See clouddirectory package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/clouddirectory/

Using the Client

To contact Amazon CloudDirectory with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the Amazon CloudDirectory client CloudDirectory for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/clouddirectory/#New

Index

Constants

View Source
const (
	// BatchReadExceptionTypeValidationException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeValidationException = "ValidationException"

	// BatchReadExceptionTypeInvalidArnException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeInvalidArnException = "InvalidArnException"

	// BatchReadExceptionTypeResourceNotFoundException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeResourceNotFoundException = "ResourceNotFoundException"

	// BatchReadExceptionTypeInvalidNextTokenException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeInvalidNextTokenException = "InvalidNextTokenException"

	// BatchReadExceptionTypeAccessDeniedException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeAccessDeniedException = "AccessDeniedException"

	// BatchReadExceptionTypeNotNodeException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeNotNodeException = "NotNodeException"

	// BatchReadExceptionTypeFacetValidationException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeFacetValidationException = "FacetValidationException"

	// BatchReadExceptionTypeCannotListParentOfRootException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeCannotListParentOfRootException = "CannotListParentOfRootException"

	// BatchReadExceptionTypeNotIndexException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeNotIndexException = "NotIndexException"

	// BatchReadExceptionTypeNotPolicyException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeNotPolicyException = "NotPolicyException"

	// BatchReadExceptionTypeDirectoryNotEnabledException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeDirectoryNotEnabledException = "DirectoryNotEnabledException"

	// BatchReadExceptionTypeLimitExceededException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeLimitExceededException = "LimitExceededException"

	// BatchReadExceptionTypeInternalServiceException is a BatchReadExceptionType enum value
	BatchReadExceptionTypeInternalServiceException = "InternalServiceException"
)
View Source
const (
	// BatchWriteExceptionTypeInternalServiceException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeInternalServiceException = "InternalServiceException"

	// BatchWriteExceptionTypeValidationException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeValidationException = "ValidationException"

	// BatchWriteExceptionTypeInvalidArnException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeInvalidArnException = "InvalidArnException"

	// BatchWriteExceptionTypeLinkNameAlreadyInUseException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeLinkNameAlreadyInUseException = "LinkNameAlreadyInUseException"

	// BatchWriteExceptionTypeStillContainsLinksException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeStillContainsLinksException = "StillContainsLinksException"

	// BatchWriteExceptionTypeFacetValidationException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeFacetValidationException = "FacetValidationException"

	// BatchWriteExceptionTypeObjectNotDetachedException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeObjectNotDetachedException = "ObjectNotDetachedException"

	// BatchWriteExceptionTypeResourceNotFoundException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeResourceNotFoundException = "ResourceNotFoundException"

	// BatchWriteExceptionTypeAccessDeniedException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeAccessDeniedException = "AccessDeniedException"

	// BatchWriteExceptionTypeInvalidAttachmentException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeInvalidAttachmentException = "InvalidAttachmentException"

	// BatchWriteExceptionTypeNotIndexException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeNotIndexException = "NotIndexException"

	// BatchWriteExceptionTypeNotNodeException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeNotNodeException = "NotNodeException"

	// BatchWriteExceptionTypeIndexedAttributeMissingException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeIndexedAttributeMissingException = "IndexedAttributeMissingException"

	// BatchWriteExceptionTypeObjectAlreadyDetachedException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeObjectAlreadyDetachedException = "ObjectAlreadyDetachedException"

	// BatchWriteExceptionTypeNotPolicyException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeNotPolicyException = "NotPolicyException"

	// BatchWriteExceptionTypeDirectoryNotEnabledException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeDirectoryNotEnabledException = "DirectoryNotEnabledException"

	// BatchWriteExceptionTypeLimitExceededException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeLimitExceededException = "LimitExceededException"

	// BatchWriteExceptionTypeUnsupportedIndexTypeException is a BatchWriteExceptionType enum value
	BatchWriteExceptionTypeUnsupportedIndexTypeException = "UnsupportedIndexTypeException"
)
View Source
const (
	// ConsistencyLevelSerializable is a ConsistencyLevel enum value
	ConsistencyLevelSerializable = "SERIALIZABLE"

	// ConsistencyLevelEventual is a ConsistencyLevel enum value
	ConsistencyLevelEventual = "EVENTUAL"
)
View Source
const (
	// DirectoryStateEnabled is a DirectoryState enum value
	DirectoryStateEnabled = "ENABLED"

	// DirectoryStateDisabled is a DirectoryState enum value
	DirectoryStateDisabled = "DISABLED"

	// DirectoryStateDeleted is a DirectoryState enum value
	DirectoryStateDeleted = "DELETED"
)
View Source
const (
	// FacetAttributeTypeString is a FacetAttributeType enum value
	FacetAttributeTypeString = "STRING"

	// FacetAttributeTypeBinary is a FacetAttributeType enum value
	FacetAttributeTypeBinary = "BINARY"

	// FacetAttributeTypeBoolean is a FacetAttributeType enum value
	FacetAttributeTypeBoolean = "BOOLEAN"

	// FacetAttributeTypeNumber is a FacetAttributeType enum value
	FacetAttributeTypeNumber = "NUMBER"

	// FacetAttributeTypeDatetime is a FacetAttributeType enum value
	FacetAttributeTypeDatetime = "DATETIME"

	// FacetAttributeTypeVariant is a FacetAttributeType enum value
	FacetAttributeTypeVariant = "VARIANT"
)
View Source
const (
	// FacetStyleStatic is a FacetStyle enum value
	FacetStyleStatic = "STATIC"

	// FacetStyleDynamic is a FacetStyle enum value
	FacetStyleDynamic = "DYNAMIC"
)
View Source
const (
	// ObjectTypeNode is a ObjectType enum value
	ObjectTypeNode = "NODE"

	// ObjectTypeLeafNode is a ObjectType enum value
	ObjectTypeLeafNode = "LEAF_NODE"

	// ObjectTypePolicy is a ObjectType enum value
	ObjectTypePolicy = "POLICY"

	// ObjectTypeIndex is a ObjectType enum value
	ObjectTypeIndex = "INDEX"
)
View Source
const (
	// RangeModeFirst is a RangeMode enum value
	RangeModeFirst = "FIRST"

	// RangeModeLast is a RangeMode enum value
	RangeModeLast = "LAST"

	// RangeModeLastBeforeMissingValues is a RangeMode enum value
	RangeModeLastBeforeMissingValues = "LAST_BEFORE_MISSING_VALUES"

	// RangeModeInclusive is a RangeMode enum value
	RangeModeInclusive = "INCLUSIVE"

	// RangeModeExclusive is a RangeMode enum value
	RangeModeExclusive = "EXCLUSIVE"
)
View Source
const (
	// RequiredAttributeBehaviorRequiredAlways is a RequiredAttributeBehavior enum value
	RequiredAttributeBehaviorRequiredAlways = "REQUIRED_ALWAYS"

	// RequiredAttributeBehaviorNotRequired is a RequiredAttributeBehavior enum value
	RequiredAttributeBehaviorNotRequired = "NOT_REQUIRED"
)
View Source
const (
	// RuleTypeBinaryLength is a RuleType enum value
	RuleTypeBinaryLength = "BINARY_LENGTH"

	// RuleTypeNumberComparison is a RuleType enum value
	RuleTypeNumberComparison = "NUMBER_COMPARISON"

	// RuleTypeStringFromSet is a RuleType enum value
	RuleTypeStringFromSet = "STRING_FROM_SET"

	// RuleTypeStringLength is a RuleType enum value
	RuleTypeStringLength = "STRING_LENGTH"
)
View Source
const (
	// UpdateActionTypeCreateOrUpdate is a UpdateActionType enum value
	UpdateActionTypeCreateOrUpdate = "CREATE_OR_UPDATE"

	// UpdateActionTypeDelete is a UpdateActionType enum value
	UpdateActionTypeDelete = "DELETE"
)
View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// Access denied. Check your permissions.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeBatchWriteException for service response error code
	// "BatchWriteException".
	//
	// A BatchWrite exception has occurred.
	ErrCodeBatchWriteException = "BatchWriteException"

	// ErrCodeCannotListParentOfRootException for service response error code
	// "CannotListParentOfRootException".
	//
	// Cannot list the parents of a Directory root.
	ErrCodeCannotListParentOfRootException = "CannotListParentOfRootException"

	// ErrCodeDirectoryAlreadyExistsException for service response error code
	// "DirectoryAlreadyExistsException".
	//
	// Indicates that a Directory could not be created due to a naming conflict.
	// Choose a different name and try again.
	ErrCodeDirectoryAlreadyExistsException = "DirectoryAlreadyExistsException"

	// ErrCodeDirectoryDeletedException for service response error code
	// "DirectoryDeletedException".
	//
	// A directory that has been deleted and to which access has been attempted.
	// Note: The requested resource will eventually cease to exist.
	ErrCodeDirectoryDeletedException = "DirectoryDeletedException"

	// ErrCodeDirectoryNotDisabledException for service response error code
	// "DirectoryNotDisabledException".
	//
	// An operation can only operate on a disabled directory.
	ErrCodeDirectoryNotDisabledException = "DirectoryNotDisabledException"

	// ErrCodeDirectoryNotEnabledException for service response error code
	// "DirectoryNotEnabledException".
	//
	// Operations are only permitted on enabled directories.
	ErrCodeDirectoryNotEnabledException = "DirectoryNotEnabledException"

	// ErrCodeFacetAlreadyExistsException for service response error code
	// "FacetAlreadyExistsException".
	//
	// A facet with the same name already exists.
	ErrCodeFacetAlreadyExistsException = "FacetAlreadyExistsException"

	// ErrCodeFacetInUseException for service response error code
	// "FacetInUseException".
	//
	// Occurs when deleting a facet that contains an attribute that is a target
	// to an attribute reference in a different facet.
	ErrCodeFacetInUseException = "FacetInUseException"

	// ErrCodeFacetNotFoundException for service response error code
	// "FacetNotFoundException".
	//
	// The specified Facet could not be found.
	ErrCodeFacetNotFoundException = "FacetNotFoundException"

	// ErrCodeFacetValidationException for service response error code
	// "FacetValidationException".
	//
	// The Facet that you provided was not well formed or could not be validated
	// with the schema.
	ErrCodeFacetValidationException = "FacetValidationException"

	// ErrCodeIncompatibleSchemaException for service response error code
	// "IncompatibleSchemaException".
	//
	// 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.
	ErrCodeIncompatibleSchemaException = "IncompatibleSchemaException"

	// ErrCodeIndexedAttributeMissingException for service response error code
	// "IndexedAttributeMissingException".
	//
	// An object has been attempted to be attached to an object that does not have
	// the appropriate attribute value.
	ErrCodeIndexedAttributeMissingException = "IndexedAttributeMissingException"

	// ErrCodeInternalServiceException for service response error code
	// "InternalServiceException".
	//
	// 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.
	ErrCodeInternalServiceException = "InternalServiceException"

	// ErrCodeInvalidArnException for service response error code
	// "InvalidArnException".
	//
	// Indicates that the provided ARN value is not valid.
	ErrCodeInvalidArnException = "InvalidArnException"

	// ErrCodeInvalidAttachmentException for service response error code
	// "InvalidAttachmentException".
	//
	// 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.
	ErrCodeInvalidAttachmentException = "InvalidAttachmentException"

	// ErrCodeInvalidFacetUpdateException for service response error code
	// "InvalidFacetUpdateException".
	//
	// An attempt to modify a Facet resulted in an invalid schema exception.
	ErrCodeInvalidFacetUpdateException = "InvalidFacetUpdateException"

	// ErrCodeInvalidNextTokenException for service response error code
	// "InvalidNextTokenException".
	//
	// Indicates that the NextToken value is not valid.
	ErrCodeInvalidNextTokenException = "InvalidNextTokenException"

	// ErrCodeInvalidRuleException for service response error code
	// "InvalidRuleException".
	//
	// Occurs when any of the rule parameter keys or values are invalid.
	ErrCodeInvalidRuleException = "InvalidRuleException"

	// ErrCodeInvalidSchemaDocException for service response error code
	// "InvalidSchemaDocException".
	//
	// Indicates that the provided SchemaDoc value is not valid.
	ErrCodeInvalidSchemaDocException = "InvalidSchemaDocException"

	// ErrCodeInvalidTaggingRequestException for service response error code
	// "InvalidTaggingRequestException".
	//
	// 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.
	ErrCodeInvalidTaggingRequestException = "InvalidTaggingRequestException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Indicates that limits are exceeded. See Limits (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html)
	// for more information.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeLinkNameAlreadyInUseException for service response error code
	// "LinkNameAlreadyInUseException".
	//
	// Indicates that a link could not be created due to a naming conflict. Choose
	// a different name and then try again.
	ErrCodeLinkNameAlreadyInUseException = "LinkNameAlreadyInUseException"

	// ErrCodeNotIndexException for service response error code
	// "NotIndexException".
	//
	// Indicates that the requested operation can only operate on index objects.
	ErrCodeNotIndexException = "NotIndexException"

	// ErrCodeNotNodeException for service response error code
	// "NotNodeException".
	//
	// Occurs when any invalid operations are performed on an object that is not
	// a node, such as calling ListObjectChildren for a leaf node object.
	ErrCodeNotNodeException = "NotNodeException"

	// ErrCodeNotPolicyException for service response error code
	// "NotPolicyException".
	//
	// Indicates that the requested operation can only operate on policy objects.
	ErrCodeNotPolicyException = "NotPolicyException"

	// ErrCodeObjectAlreadyDetachedException for service response error code
	// "ObjectAlreadyDetachedException".
	//
	// Indicates that the object is not attached to the index.
	ErrCodeObjectAlreadyDetachedException = "ObjectAlreadyDetachedException"

	// ErrCodeObjectNotDetachedException for service response error code
	// "ObjectNotDetachedException".
	//
	// Indicates that the requested operation cannot be completed because the object
	// has not been detached from the tree.
	ErrCodeObjectNotDetachedException = "ObjectNotDetachedException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The specified resource could not be found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeRetryableConflictException for service response error code
	// "RetryableConflictException".
	//
	// 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.
	ErrCodeRetryableConflictException = "RetryableConflictException"

	// ErrCodeSchemaAlreadyExistsException for service response error code
	// "SchemaAlreadyExistsException".
	//
	// Indicates that a schema could not be created due to a naming conflict. Please
	// select a different name and then try again.
	ErrCodeSchemaAlreadyExistsException = "SchemaAlreadyExistsException"

	// ErrCodeSchemaAlreadyPublishedException for service response error code
	// "SchemaAlreadyPublishedException".
	//
	// Indicates that a schema is already published.
	ErrCodeSchemaAlreadyPublishedException = "SchemaAlreadyPublishedException"

	// ErrCodeStillContainsLinksException for service response error code
	// "StillContainsLinksException".
	//
	// The object could not be deleted because links still exist. Remove the links
	// and then try the operation again.
	ErrCodeStillContainsLinksException = "StillContainsLinksException"

	// ErrCodeUnsupportedIndexTypeException for service response error code
	// "UnsupportedIndexTypeException".
	//
	// Indicates that the requested index type is not supported.
	ErrCodeUnsupportedIndexTypeException = "UnsupportedIndexTypeException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Indicates that your request is malformed in some manner. See the exception
	// message.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "clouddirectory" // Name of service.
	EndpointsID = ServiceName      // ID to lookup a service endpoint with.
	ServiceID   = "CloudDirectory" // ServiceID is a unique identifer of a specific service.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFacetToObjectInput

type AddFacetToObjectInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Attributes on the facet that you are adding to the object.
	ObjectAttributeList []*AttributeKeyAndValue `type:"list"`

	// A reference to the object you are adding the specified facet to.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifiers for the facet that you are adding to the object. See SchemaFacet
	// for details.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AddFacetToObjectInput) GoString

func (s AddFacetToObjectInput) GoString() string

GoString returns the string representation

func (*AddFacetToObjectInput) SetDirectoryArn

func (s *AddFacetToObjectInput) SetDirectoryArn(v string) *AddFacetToObjectInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*AddFacetToObjectInput) SetObjectAttributeList

func (s *AddFacetToObjectInput) SetObjectAttributeList(v []*AttributeKeyAndValue) *AddFacetToObjectInput

SetObjectAttributeList sets the ObjectAttributeList field's value.

func (*AddFacetToObjectInput) SetObjectReference

func (s *AddFacetToObjectInput) SetObjectReference(v *ObjectReference) *AddFacetToObjectInput

SetObjectReference sets the ObjectReference field's value.

func (*AddFacetToObjectInput) SetSchemaFacet

SetSchemaFacet sets the SchemaFacet field's value.

func (AddFacetToObjectInput) String

func (s AddFacetToObjectInput) String() string

String returns the string representation

func (*AddFacetToObjectInput) Validate

func (s *AddFacetToObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AddFacetToObjectOutput

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

func (AddFacetToObjectOutput) GoString

func (s AddFacetToObjectOutput) GoString() string

GoString returns the string representation

func (AddFacetToObjectOutput) String

func (s AddFacetToObjectOutput) String() string

String returns the string representation

type ApplySchemaInput

type ApplySchemaInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory into
	// which the schema is copied. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Published schema Amazon Resource Name (ARN) that needs to be copied. For
	// more information, see arns.
	//
	// PublishedSchemaArn is a required field
	PublishedSchemaArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ApplySchemaInput) GoString

func (s ApplySchemaInput) GoString() string

GoString returns the string representation

func (*ApplySchemaInput) SetDirectoryArn

func (s *ApplySchemaInput) SetDirectoryArn(v string) *ApplySchemaInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*ApplySchemaInput) SetPublishedSchemaArn

func (s *ApplySchemaInput) SetPublishedSchemaArn(v string) *ApplySchemaInput

SetPublishedSchemaArn sets the PublishedSchemaArn field's value.

func (ApplySchemaInput) String

func (s ApplySchemaInput) String() string

String returns the string representation

func (*ApplySchemaInput) Validate

func (s *ApplySchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ApplySchemaOutput

type ApplySchemaOutput struct {

	// The applied schema ARN that is associated with the copied schema in the Directory.
	// You can use this ARN to describe the schema information applied on this directory.
	// For more information, see arns.
	AppliedSchemaArn *string `type:"string"`

	// The ARN that is associated with the Directory. For more information, see
	// arns.
	DirectoryArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ApplySchemaOutput) GoString

func (s ApplySchemaOutput) GoString() string

GoString returns the string representation

func (*ApplySchemaOutput) SetAppliedSchemaArn

func (s *ApplySchemaOutput) SetAppliedSchemaArn(v string) *ApplySchemaOutput

SetAppliedSchemaArn sets the AppliedSchemaArn field's value.

func (*ApplySchemaOutput) SetDirectoryArn

func (s *ApplySchemaOutput) SetDirectoryArn(v string) *ApplySchemaOutput

SetDirectoryArn sets the DirectoryArn field's value.

func (ApplySchemaOutput) String

func (s ApplySchemaOutput) String() string

String returns the string representation

type AttachObjectInput

type AttachObjectInput struct {

	// The child object reference to be attached to the object.
	//
	// ChildReference is a required field
	ChildReference *ObjectReference `type:"structure" required:"true"`

	// Amazon Resource Name (ARN) that is associated with the Directory where both
	// objects reside. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The link name with which the child object is attached to the parent.
	//
	// LinkName is a required field
	LinkName *string `min:"1" type:"string" required:"true"`

	// The parent object reference.
	//
	// ParentReference is a required field
	ParentReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AttachObjectInput) GoString

func (s AttachObjectInput) GoString() string

GoString returns the string representation

func (*AttachObjectInput) SetChildReference

func (s *AttachObjectInput) SetChildReference(v *ObjectReference) *AttachObjectInput

SetChildReference sets the ChildReference field's value.

func (*AttachObjectInput) SetDirectoryArn

func (s *AttachObjectInput) SetDirectoryArn(v string) *AttachObjectInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*AttachObjectInput) SetLinkName

func (s *AttachObjectInput) SetLinkName(v string) *AttachObjectInput

SetLinkName sets the LinkName field's value.

func (*AttachObjectInput) SetParentReference

func (s *AttachObjectInput) SetParentReference(v *ObjectReference) *AttachObjectInput

SetParentReference sets the ParentReference field's value.

func (AttachObjectInput) String

func (s AttachObjectInput) String() string

String returns the string representation

func (*AttachObjectInput) Validate

func (s *AttachObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttachObjectOutput

type AttachObjectOutput struct {

	// The attached ObjectIdentifier, which is the child ObjectIdentifier.
	AttachedObjectIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (AttachObjectOutput) GoString

func (s AttachObjectOutput) GoString() string

GoString returns the string representation

func (*AttachObjectOutput) SetAttachedObjectIdentifier

func (s *AttachObjectOutput) SetAttachedObjectIdentifier(v string) *AttachObjectOutput

SetAttachedObjectIdentifier sets the AttachedObjectIdentifier field's value.

func (AttachObjectOutput) String

func (s AttachObjectOutput) String() string

String returns the string representation

type AttachPolicyInput

type AttachPolicyInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// both objects reside. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The reference that identifies the object to which the policy will be attached.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// The reference that is associated with the policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AttachPolicyInput) GoString

func (s AttachPolicyInput) GoString() string

GoString returns the string representation

func (*AttachPolicyInput) SetDirectoryArn

func (s *AttachPolicyInput) SetDirectoryArn(v string) *AttachPolicyInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*AttachPolicyInput) SetObjectReference

func (s *AttachPolicyInput) SetObjectReference(v *ObjectReference) *AttachPolicyInput

SetObjectReference sets the ObjectReference field's value.

func (*AttachPolicyInput) SetPolicyReference

func (s *AttachPolicyInput) SetPolicyReference(v *ObjectReference) *AttachPolicyInput

SetPolicyReference sets the PolicyReference field's value.

func (AttachPolicyInput) String

func (s AttachPolicyInput) String() string

String returns the string representation

func (*AttachPolicyInput) Validate

func (s *AttachPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttachPolicyOutput

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

func (AttachPolicyOutput) GoString

func (s AttachPolicyOutput) GoString() string

GoString returns the string representation

func (AttachPolicyOutput) String

func (s AttachPolicyOutput) String() string

String returns the string representation

type AttachToIndexInput

type AttachToIndexInput struct {

	// The Amazon Resource Name (ARN) of the directory where the object and index
	// exist.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A reference to the index that you are attaching the object to.
	//
	// IndexReference is a required field
	IndexReference *ObjectReference `type:"structure" required:"true"`

	// A reference to the object that you are attaching to the index.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AttachToIndexInput) GoString

func (s AttachToIndexInput) GoString() string

GoString returns the string representation

func (*AttachToIndexInput) SetDirectoryArn

func (s *AttachToIndexInput) SetDirectoryArn(v string) *AttachToIndexInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*AttachToIndexInput) SetIndexReference

func (s *AttachToIndexInput) SetIndexReference(v *ObjectReference) *AttachToIndexInput

SetIndexReference sets the IndexReference field's value.

func (*AttachToIndexInput) SetTargetReference

func (s *AttachToIndexInput) SetTargetReference(v *ObjectReference) *AttachToIndexInput

SetTargetReference sets the TargetReference field's value.

func (AttachToIndexInput) String

func (s AttachToIndexInput) String() string

String returns the string representation

func (*AttachToIndexInput) Validate

func (s *AttachToIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttachToIndexOutput

type AttachToIndexOutput struct {

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

func (AttachToIndexOutput) GoString

func (s AttachToIndexOutput) GoString() string

GoString returns the string representation

func (*AttachToIndexOutput) SetAttachedObjectIdentifier

func (s *AttachToIndexOutput) SetAttachedObjectIdentifier(v string) *AttachToIndexOutput

SetAttachedObjectIdentifier sets the AttachedObjectIdentifier field's value.

func (AttachToIndexOutput) String

func (s AttachToIndexOutput) String() string

String returns the string representation

type AttachTypedLinkInput added in v1.8.31

type AttachTypedLinkInput struct {

	// A set of attributes that are associated with the typed link.
	//
	// Attributes is a required field
	Attributes []*AttributeNameAndValue `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the directory where you want to attach
	// the typed link.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Identifies the source object that the typed link will attach to.
	//
	// SourceObjectReference is a required field
	SourceObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifies the target object that the typed link will attach to.
	//
	// TargetObjectReference is a required field
	TargetObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifies the typed link facet that is associated with the typed link.
	//
	// TypedLinkFacet is a required field
	TypedLinkFacet *TypedLinkSchemaAndFacetName `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (AttachTypedLinkInput) GoString added in v1.8.31

func (s AttachTypedLinkInput) GoString() string

GoString returns the string representation

func (*AttachTypedLinkInput) SetAttributes added in v1.8.31

SetAttributes sets the Attributes field's value.

func (*AttachTypedLinkInput) SetDirectoryArn added in v1.8.31

func (s *AttachTypedLinkInput) SetDirectoryArn(v string) *AttachTypedLinkInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*AttachTypedLinkInput) SetSourceObjectReference added in v1.8.31

func (s *AttachTypedLinkInput) SetSourceObjectReference(v *ObjectReference) *AttachTypedLinkInput

SetSourceObjectReference sets the SourceObjectReference field's value.

func (*AttachTypedLinkInput) SetTargetObjectReference added in v1.8.31

func (s *AttachTypedLinkInput) SetTargetObjectReference(v *ObjectReference) *AttachTypedLinkInput

SetTargetObjectReference sets the TargetObjectReference field's value.

func (*AttachTypedLinkInput) SetTypedLinkFacet added in v1.8.31

SetTypedLinkFacet sets the TypedLinkFacet field's value.

func (AttachTypedLinkInput) String added in v1.8.31

func (s AttachTypedLinkInput) String() string

String returns the string representation

func (*AttachTypedLinkInput) Validate added in v1.8.31

func (s *AttachTypedLinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttachTypedLinkOutput added in v1.8.31

type AttachTypedLinkOutput struct {

	// Returns a typed link specifier as output.
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure"`
	// contains filtered or unexported fields
}

func (AttachTypedLinkOutput) GoString added in v1.8.31

func (s AttachTypedLinkOutput) GoString() string

GoString returns the string representation

func (*AttachTypedLinkOutput) SetTypedLinkSpecifier added in v1.8.31

func (s *AttachTypedLinkOutput) SetTypedLinkSpecifier(v *TypedLinkSpecifier) *AttachTypedLinkOutput

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (AttachTypedLinkOutput) String added in v1.8.31

func (s AttachTypedLinkOutput) String() string

String returns the string representation

type AttributeKey

type AttributeKey struct {

	// The name of the facet that the attribute exists within.
	//
	// FacetName is a required field
	FacetName *string `min:"1" type:"string" required:"true"`

	// The name of the attribute.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the schema that contains the facet and
	// attribute.
	//
	// SchemaArn is a required field
	SchemaArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

A unique identifier for an attribute.

func (AttributeKey) GoString

func (s AttributeKey) GoString() string

GoString returns the string representation

func (*AttributeKey) SetFacetName

func (s *AttributeKey) SetFacetName(v string) *AttributeKey

SetFacetName sets the FacetName field's value.

func (*AttributeKey) SetName

func (s *AttributeKey) SetName(v string) *AttributeKey

SetName sets the Name field's value.

func (*AttributeKey) SetSchemaArn

func (s *AttributeKey) SetSchemaArn(v string) *AttributeKey

SetSchemaArn sets the SchemaArn field's value.

func (AttributeKey) String

func (s AttributeKey) String() string

String returns the string representation

func (*AttributeKey) Validate

func (s *AttributeKey) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttributeKeyAndValue

type AttributeKeyAndValue struct {

	// The key of the attribute.
	//
	// Key is a required field
	Key *AttributeKey `type:"structure" required:"true"`

	// The value of the attribute.
	//
	// Value is a required field
	Value *TypedAttributeValue `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

The combination of an attribute key and an attribute value.

func (AttributeKeyAndValue) GoString

func (s AttributeKeyAndValue) GoString() string

GoString returns the string representation

func (*AttributeKeyAndValue) SetKey

SetKey sets the Key field's value.

func (*AttributeKeyAndValue) SetValue

SetValue sets the Value field's value.

func (AttributeKeyAndValue) String

func (s AttributeKeyAndValue) String() string

String returns the string representation

func (*AttributeKeyAndValue) Validate

func (s *AttributeKeyAndValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AttributeNameAndValue added in v1.8.31

type AttributeNameAndValue struct {

	// The attribute name of the typed link.
	//
	// AttributeName is a required field
	AttributeName *string `min:"1" type:"string" required:"true"`

	// The value for the typed link.
	//
	// Value is a required field
	Value *TypedAttributeValue `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Identifies the attribute name and value for a typed link.

func (AttributeNameAndValue) GoString added in v1.8.31

func (s AttributeNameAndValue) GoString() string

GoString returns the string representation

func (*AttributeNameAndValue) SetAttributeName added in v1.8.31

func (s *AttributeNameAndValue) SetAttributeName(v string) *AttributeNameAndValue

SetAttributeName sets the AttributeName field's value.

func (*AttributeNameAndValue) SetValue added in v1.8.31

SetValue sets the Value field's value.

func (AttributeNameAndValue) String added in v1.8.31

func (s AttributeNameAndValue) String() string

String returns the string representation

func (*AttributeNameAndValue) Validate added in v1.8.31

func (s *AttributeNameAndValue) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAddFacetToObject

type BatchAddFacetToObject struct {

	// The attributes to set on the object.
	//
	// ObjectAttributeList is a required field
	ObjectAttributeList []*AttributeKeyAndValue `type:"list" required:"true"`

	// A reference to the object being mutated.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// Represents the facet being added to the object.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (BatchAddFacetToObject) GoString

func (s BatchAddFacetToObject) GoString() string

GoString returns the string representation

func (*BatchAddFacetToObject) SetObjectAttributeList

func (s *BatchAddFacetToObject) SetObjectAttributeList(v []*AttributeKeyAndValue) *BatchAddFacetToObject

SetObjectAttributeList sets the ObjectAttributeList field's value.

func (*BatchAddFacetToObject) SetObjectReference

func (s *BatchAddFacetToObject) SetObjectReference(v *ObjectReference) *BatchAddFacetToObject

SetObjectReference sets the ObjectReference field's value.

func (*BatchAddFacetToObject) SetSchemaFacet

SetSchemaFacet sets the SchemaFacet field's value.

func (BatchAddFacetToObject) String

func (s BatchAddFacetToObject) String() string

String returns the string representation

func (*BatchAddFacetToObject) Validate

func (s *BatchAddFacetToObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAddFacetToObjectResponse

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

The result of a batch add facet to object operation.

func (BatchAddFacetToObjectResponse) GoString

GoString returns the string representation

func (BatchAddFacetToObjectResponse) String

String returns the string representation

type BatchAttachObject

type BatchAttachObject struct {

	// The child object reference that is to be attached to the object.
	//
	// ChildReference is a required field
	ChildReference *ObjectReference `type:"structure" required:"true"`

	// The name of the link.
	//
	// LinkName is a required field
	LinkName *string `min:"1" type:"string" required:"true"`

	// The parent object reference.
	//
	// ParentReference is a required field
	ParentReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of an AttachObject operation.

func (BatchAttachObject) GoString

func (s BatchAttachObject) GoString() string

GoString returns the string representation

func (*BatchAttachObject) SetChildReference

func (s *BatchAttachObject) SetChildReference(v *ObjectReference) *BatchAttachObject

SetChildReference sets the ChildReference field's value.

func (*BatchAttachObject) SetLinkName

func (s *BatchAttachObject) SetLinkName(v string) *BatchAttachObject

SetLinkName sets the LinkName field's value.

func (*BatchAttachObject) SetParentReference

func (s *BatchAttachObject) SetParentReference(v *ObjectReference) *BatchAttachObject

SetParentReference sets the ParentReference field's value.

func (BatchAttachObject) String

func (s BatchAttachObject) String() string

String returns the string representation

func (*BatchAttachObject) Validate

func (s *BatchAttachObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAttachObjectResponse

type BatchAttachObjectResponse struct {

	// The ObjectIdentifier of the object that has been attached.
	AttachedObjectIdentifier *string `locationName:"attachedObjectIdentifier" type:"string"`
	// contains filtered or unexported fields
}

Represents the output batch AttachObject response operation.

func (BatchAttachObjectResponse) GoString

func (s BatchAttachObjectResponse) GoString() string

GoString returns the string representation

func (*BatchAttachObjectResponse) SetAttachedObjectIdentifier

func (s *BatchAttachObjectResponse) SetAttachedObjectIdentifier(v string) *BatchAttachObjectResponse

SetAttachedObjectIdentifier sets the AttachedObjectIdentifier field's value.

func (BatchAttachObjectResponse) String

func (s BatchAttachObjectResponse) String() string

String returns the string representation

type BatchAttachPolicy added in v1.10.16

type BatchAttachPolicy struct {

	// The reference that identifies the object to which the policy will be attached.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// The reference that is associated with the policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchAttachPolicy) GoString added in v1.10.16

func (s BatchAttachPolicy) GoString() string

GoString returns the string representation

func (*BatchAttachPolicy) SetObjectReference added in v1.10.16

func (s *BatchAttachPolicy) SetObjectReference(v *ObjectReference) *BatchAttachPolicy

SetObjectReference sets the ObjectReference field's value.

func (*BatchAttachPolicy) SetPolicyReference added in v1.10.16

func (s *BatchAttachPolicy) SetPolicyReference(v *ObjectReference) *BatchAttachPolicy

SetPolicyReference sets the PolicyReference field's value.

func (BatchAttachPolicy) String added in v1.10.16

func (s BatchAttachPolicy) String() string

String returns the string representation

func (*BatchAttachPolicy) Validate added in v1.10.16

func (s *BatchAttachPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAttachPolicyResponse added in v1.10.16

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

Represents the output of an AttachPolicy response operation.

func (BatchAttachPolicyResponse) GoString added in v1.10.16

func (s BatchAttachPolicyResponse) GoString() string

GoString returns the string representation

func (BatchAttachPolicyResponse) String added in v1.10.16

func (s BatchAttachPolicyResponse) String() string

String returns the string representation

type BatchAttachToIndex added in v1.10.16

type BatchAttachToIndex struct {

	// A reference to the index that you are attaching the object to.
	//
	// IndexReference is a required field
	IndexReference *ObjectReference `type:"structure" required:"true"`

	// A reference to the object that you are attaching to the index.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchAttachToIndex) GoString added in v1.10.16

func (s BatchAttachToIndex) GoString() string

GoString returns the string representation

func (*BatchAttachToIndex) SetIndexReference added in v1.10.16

func (s *BatchAttachToIndex) SetIndexReference(v *ObjectReference) *BatchAttachToIndex

SetIndexReference sets the IndexReference field's value.

func (*BatchAttachToIndex) SetTargetReference added in v1.10.16

func (s *BatchAttachToIndex) SetTargetReference(v *ObjectReference) *BatchAttachToIndex

SetTargetReference sets the TargetReference field's value.

func (BatchAttachToIndex) String added in v1.10.16

func (s BatchAttachToIndex) String() string

String returns the string representation

func (*BatchAttachToIndex) Validate added in v1.10.16

func (s *BatchAttachToIndex) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAttachToIndexResponse added in v1.10.16

type BatchAttachToIndexResponse struct {

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

Represents the output of a AttachToIndex response operation.

func (BatchAttachToIndexResponse) GoString added in v1.10.16

func (s BatchAttachToIndexResponse) GoString() string

GoString returns the string representation

func (*BatchAttachToIndexResponse) SetAttachedObjectIdentifier added in v1.10.16

func (s *BatchAttachToIndexResponse) SetAttachedObjectIdentifier(v string) *BatchAttachToIndexResponse

SetAttachedObjectIdentifier sets the AttachedObjectIdentifier field's value.

func (BatchAttachToIndexResponse) String added in v1.10.16

String returns the string representation

type BatchAttachTypedLink struct {

	// A set of attributes that are associated with the typed link.
	//
	// Attributes is a required field
	Attributes []*AttributeNameAndValue `type:"list" required:"true"`

	// Identifies the source object that the typed link will attach to.
	//
	// SourceObjectReference is a required field
	SourceObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifies the target object that the typed link will attach to.
	//
	// TargetObjectReference is a required field
	TargetObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifies the typed link facet that is associated with the typed link.
	//
	// TypedLinkFacet is a required field
	TypedLinkFacet *TypedLinkSchemaAndFacetName `type:"structure" required:"true"`
	// 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.

func (BatchAttachTypedLink) GoString added in v1.10.16

func (s BatchAttachTypedLink) GoString() string

GoString returns the string representation

func (*BatchAttachTypedLink) SetAttributes added in v1.10.16

SetAttributes sets the Attributes field's value.

func (*BatchAttachTypedLink) SetSourceObjectReference added in v1.10.16

func (s *BatchAttachTypedLink) SetSourceObjectReference(v *ObjectReference) *BatchAttachTypedLink

SetSourceObjectReference sets the SourceObjectReference field's value.

func (*BatchAttachTypedLink) SetTargetObjectReference added in v1.10.16

func (s *BatchAttachTypedLink) SetTargetObjectReference(v *ObjectReference) *BatchAttachTypedLink

SetTargetObjectReference sets the TargetObjectReference field's value.

func (*BatchAttachTypedLink) SetTypedLinkFacet added in v1.10.16

SetTypedLinkFacet sets the TypedLinkFacet field's value.

func (BatchAttachTypedLink) String added in v1.10.16

func (s BatchAttachTypedLink) String() string

String returns the string representation

func (*BatchAttachTypedLink) Validate added in v1.10.16

func (s *BatchAttachTypedLink) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchAttachTypedLinkResponse added in v1.10.16

type BatchAttachTypedLinkResponse struct {

	// Returns a typed link specifier as output.
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a AttachTypedLink response operation.

func (BatchAttachTypedLinkResponse) GoString added in v1.10.16

func (s BatchAttachTypedLinkResponse) GoString() string

GoString returns the string representation

func (*BatchAttachTypedLinkResponse) SetTypedLinkSpecifier added in v1.10.16

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (BatchAttachTypedLinkResponse) String added in v1.10.16

String returns the string representation

type BatchCreateIndex added in v1.10.16

type BatchCreateIndex struct {

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

	// Indicates whether the attribute that is being indexed has unique values or
	// not.
	//
	// IsUnique is a required field
	IsUnique *bool `type:"boolean" required:"true"`

	// The name of the link between the parent object and the index object.
	LinkName *string `min:"1" type:"string"`

	// Specifies the attributes that should be indexed on. Currently only a single
	// attribute is supported.
	//
	// OrderedIndexedAttributeList is a required field
	OrderedIndexedAttributeList []*AttributeKey `type:"list" required:"true"`

	// A reference to the parent object that contains the index object.
	ParentReference *ObjectReference `type:"structure"`
	// contains filtered or unexported fields
}

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

func (BatchCreateIndex) GoString added in v1.10.16

func (s BatchCreateIndex) GoString() string

GoString returns the string representation

func (*BatchCreateIndex) SetBatchReferenceName added in v1.10.16

func (s *BatchCreateIndex) SetBatchReferenceName(v string) *BatchCreateIndex

SetBatchReferenceName sets the BatchReferenceName field's value.

func (*BatchCreateIndex) SetIsUnique added in v1.10.16

func (s *BatchCreateIndex) SetIsUnique(v bool) *BatchCreateIndex

SetIsUnique sets the IsUnique field's value.

func (*BatchCreateIndex) SetLinkName added in v1.10.16

func (s *BatchCreateIndex) SetLinkName(v string) *BatchCreateIndex

SetLinkName sets the LinkName field's value.

func (*BatchCreateIndex) SetOrderedIndexedAttributeList added in v1.10.16

func (s *BatchCreateIndex) SetOrderedIndexedAttributeList(v []*AttributeKey) *BatchCreateIndex

SetOrderedIndexedAttributeList sets the OrderedIndexedAttributeList field's value.

func (*BatchCreateIndex) SetParentReference added in v1.10.16

func (s *BatchCreateIndex) SetParentReference(v *ObjectReference) *BatchCreateIndex

SetParentReference sets the ParentReference field's value.

func (BatchCreateIndex) String added in v1.10.16

func (s BatchCreateIndex) String() string

String returns the string representation

func (*BatchCreateIndex) Validate added in v1.10.16

func (s *BatchCreateIndex) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchCreateIndexResponse added in v1.10.16

type BatchCreateIndexResponse struct {

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

Represents the output of a CreateIndex response operation.

func (BatchCreateIndexResponse) GoString added in v1.10.16

func (s BatchCreateIndexResponse) GoString() string

GoString returns the string representation

func (*BatchCreateIndexResponse) SetObjectIdentifier added in v1.10.16

func (s *BatchCreateIndexResponse) SetObjectIdentifier(v string) *BatchCreateIndexResponse

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (BatchCreateIndexResponse) String added in v1.10.16

func (s BatchCreateIndexResponse) String() string

String returns the string representation

type BatchCreateObject

type BatchCreateObject struct {

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

	// The name of the link.
	LinkName *string `min:"1" type:"string"`

	// An attribute map, which contains an attribute ARN as the key and attribute
	// value as the map value.
	//
	// ObjectAttributeList is a required field
	ObjectAttributeList []*AttributeKeyAndValue `type:"list" required:"true"`

	// If specified, the parent reference to which this object will be attached.
	ParentReference *ObjectReference `type:"structure"`

	// A list of FacetArns that will be associated with the object. For more information,
	// see arns.
	//
	// SchemaFacet is a required field
	SchemaFacet []*SchemaFacet `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a CreateObject operation.

func (BatchCreateObject) GoString

func (s BatchCreateObject) GoString() string

GoString returns the string representation

func (*BatchCreateObject) SetBatchReferenceName

func (s *BatchCreateObject) SetBatchReferenceName(v string) *BatchCreateObject

SetBatchReferenceName sets the BatchReferenceName field's value.

func (*BatchCreateObject) SetLinkName

func (s *BatchCreateObject) SetLinkName(v string) *BatchCreateObject

SetLinkName sets the LinkName field's value.

func (*BatchCreateObject) SetObjectAttributeList

func (s *BatchCreateObject) SetObjectAttributeList(v []*AttributeKeyAndValue) *BatchCreateObject

SetObjectAttributeList sets the ObjectAttributeList field's value.

func (*BatchCreateObject) SetParentReference

func (s *BatchCreateObject) SetParentReference(v *ObjectReference) *BatchCreateObject

SetParentReference sets the ParentReference field's value.

func (*BatchCreateObject) SetSchemaFacet

func (s *BatchCreateObject) SetSchemaFacet(v []*SchemaFacet) *BatchCreateObject

SetSchemaFacet sets the SchemaFacet field's value.

func (BatchCreateObject) String

func (s BatchCreateObject) String() string

String returns the string representation

func (*BatchCreateObject) Validate

func (s *BatchCreateObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchCreateObjectResponse

type BatchCreateObjectResponse struct {

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

Represents the output of a CreateObject response operation.

func (BatchCreateObjectResponse) GoString

func (s BatchCreateObjectResponse) GoString() string

GoString returns the string representation

func (*BatchCreateObjectResponse) SetObjectIdentifier

func (s *BatchCreateObjectResponse) SetObjectIdentifier(v string) *BatchCreateObjectResponse

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (BatchCreateObjectResponse) String

func (s BatchCreateObjectResponse) String() string

String returns the string representation

type BatchDeleteObject

type BatchDeleteObject struct {

	// The reference that identifies the object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DeleteObject operation.

func (BatchDeleteObject) GoString

func (s BatchDeleteObject) GoString() string

GoString returns the string representation

func (*BatchDeleteObject) SetObjectReference

func (s *BatchDeleteObject) SetObjectReference(v *ObjectReference) *BatchDeleteObject

SetObjectReference sets the ObjectReference field's value.

func (BatchDeleteObject) String

func (s BatchDeleteObject) String() string

String returns the string representation

func (*BatchDeleteObject) Validate

func (s *BatchDeleteObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDeleteObjectResponse

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

Represents the output of a DeleteObject response operation.

func (BatchDeleteObjectResponse) GoString

func (s BatchDeleteObjectResponse) GoString() string

GoString returns the string representation

func (BatchDeleteObjectResponse) String

func (s BatchDeleteObjectResponse) String() string

String returns the string representation

type BatchDetachFromIndex added in v1.10.16

type BatchDetachFromIndex struct {

	// A reference to the index object.
	//
	// IndexReference is a required field
	IndexReference *ObjectReference `type:"structure" required:"true"`

	// A reference to the object being detached from the index.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchDetachFromIndex) GoString added in v1.10.16

func (s BatchDetachFromIndex) GoString() string

GoString returns the string representation

func (*BatchDetachFromIndex) SetIndexReference added in v1.10.16

func (s *BatchDetachFromIndex) SetIndexReference(v *ObjectReference) *BatchDetachFromIndex

SetIndexReference sets the IndexReference field's value.

func (*BatchDetachFromIndex) SetTargetReference added in v1.10.16

func (s *BatchDetachFromIndex) SetTargetReference(v *ObjectReference) *BatchDetachFromIndex

SetTargetReference sets the TargetReference field's value.

func (BatchDetachFromIndex) String added in v1.10.16

func (s BatchDetachFromIndex) String() string

String returns the string representation

func (*BatchDetachFromIndex) Validate added in v1.10.16

func (s *BatchDetachFromIndex) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetachFromIndexResponse added in v1.10.16

type BatchDetachFromIndexResponse struct {

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

Represents the output of a DetachFromIndex response operation.

func (BatchDetachFromIndexResponse) GoString added in v1.10.16

func (s BatchDetachFromIndexResponse) GoString() string

GoString returns the string representation

func (*BatchDetachFromIndexResponse) SetDetachedObjectIdentifier added in v1.10.16

func (s *BatchDetachFromIndexResponse) SetDetachedObjectIdentifier(v string) *BatchDetachFromIndexResponse

SetDetachedObjectIdentifier sets the DetachedObjectIdentifier field's value.

func (BatchDetachFromIndexResponse) String added in v1.10.16

String returns the string representation

type BatchDetachObject

type BatchDetachObject struct {

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

	// The name of the link.
	//
	// LinkName is a required field
	LinkName *string `min:"1" type:"string" required:"true"`

	// Parent reference from which the object with the specified link name is detached.
	//
	// ParentReference is a required field
	ParentReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a DetachObject operation.

func (BatchDetachObject) GoString

func (s BatchDetachObject) GoString() string

GoString returns the string representation

func (*BatchDetachObject) SetBatchReferenceName

func (s *BatchDetachObject) SetBatchReferenceName(v string) *BatchDetachObject

SetBatchReferenceName sets the BatchReferenceName field's value.

func (*BatchDetachObject) SetLinkName

func (s *BatchDetachObject) SetLinkName(v string) *BatchDetachObject

SetLinkName sets the LinkName field's value.

func (*BatchDetachObject) SetParentReference

func (s *BatchDetachObject) SetParentReference(v *ObjectReference) *BatchDetachObject

SetParentReference sets the ParentReference field's value.

func (BatchDetachObject) String

func (s BatchDetachObject) String() string

String returns the string representation

func (*BatchDetachObject) Validate

func (s *BatchDetachObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetachObjectResponse

type BatchDetachObjectResponse struct {

	// The ObjectIdentifier of the detached object.
	DetachedObjectIdentifier *string `locationName:"detachedObjectIdentifier" type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a DetachObject response operation.

func (BatchDetachObjectResponse) GoString

func (s BatchDetachObjectResponse) GoString() string

GoString returns the string representation

func (*BatchDetachObjectResponse) SetDetachedObjectIdentifier

func (s *BatchDetachObjectResponse) SetDetachedObjectIdentifier(v string) *BatchDetachObjectResponse

SetDetachedObjectIdentifier sets the DetachedObjectIdentifier field's value.

func (BatchDetachObjectResponse) String

func (s BatchDetachObjectResponse) String() string

String returns the string representation

type BatchDetachPolicy added in v1.10.23

type BatchDetachPolicy struct {

	// Reference that identifies the object whose policy object will be detached.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// Reference that identifies the policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchDetachPolicy) GoString added in v1.10.23

func (s BatchDetachPolicy) GoString() string

GoString returns the string representation

func (*BatchDetachPolicy) SetObjectReference added in v1.10.23

func (s *BatchDetachPolicy) SetObjectReference(v *ObjectReference) *BatchDetachPolicy

SetObjectReference sets the ObjectReference field's value.

func (*BatchDetachPolicy) SetPolicyReference added in v1.10.23

func (s *BatchDetachPolicy) SetPolicyReference(v *ObjectReference) *BatchDetachPolicy

SetPolicyReference sets the PolicyReference field's value.

func (BatchDetachPolicy) String added in v1.10.23

func (s BatchDetachPolicy) String() string

String returns the string representation

func (*BatchDetachPolicy) Validate added in v1.10.23

func (s *BatchDetachPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetachPolicyResponse added in v1.10.23

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

Represents the output of a DetachPolicy response operation.

func (BatchDetachPolicyResponse) GoString added in v1.10.23

func (s BatchDetachPolicyResponse) GoString() string

GoString returns the string representation

func (BatchDetachPolicyResponse) String added in v1.10.23

func (s BatchDetachPolicyResponse) String() string

String returns the string representation

type BatchDetachTypedLink struct {

	// Used to accept a typed link specifier as input.
	//
	// TypedLinkSpecifier is a required field
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure" required:"true"`
	// 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.

func (BatchDetachTypedLink) GoString added in v1.10.16

func (s BatchDetachTypedLink) GoString() string

GoString returns the string representation

func (*BatchDetachTypedLink) SetTypedLinkSpecifier added in v1.10.16

func (s *BatchDetachTypedLink) SetTypedLinkSpecifier(v *TypedLinkSpecifier) *BatchDetachTypedLink

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (BatchDetachTypedLink) String added in v1.10.16

func (s BatchDetachTypedLink) String() string

String returns the string representation

func (*BatchDetachTypedLink) Validate added in v1.10.16

func (s *BatchDetachTypedLink) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchDetachTypedLinkResponse added in v1.10.16

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

Represents the output of a DetachTypedLink response operation.

func (BatchDetachTypedLinkResponse) GoString added in v1.10.16

func (s BatchDetachTypedLinkResponse) GoString() string

GoString returns the string representation

func (BatchDetachTypedLinkResponse) String added in v1.10.16

String returns the string representation

type BatchGetLinkAttributes added in v1.14.4

type BatchGetLinkAttributes struct {

	// A list of attribute names whose values will be retrieved.
	//
	// AttributeNames is a required field
	AttributeNames []*string `type:"list" required:"true"`

	// Allows a typed link specifier to be accepted as input.
	//
	// TypedLinkSpecifier is a required field
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure" required:"true"`
	// 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.

func (BatchGetLinkAttributes) GoString added in v1.14.4

func (s BatchGetLinkAttributes) GoString() string

GoString returns the string representation

func (*BatchGetLinkAttributes) SetAttributeNames added in v1.14.4

func (s *BatchGetLinkAttributes) SetAttributeNames(v []*string) *BatchGetLinkAttributes

SetAttributeNames sets the AttributeNames field's value.

func (*BatchGetLinkAttributes) SetTypedLinkSpecifier added in v1.14.4

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (BatchGetLinkAttributes) String added in v1.14.4

func (s BatchGetLinkAttributes) String() string

String returns the string representation

func (*BatchGetLinkAttributes) Validate added in v1.14.4

func (s *BatchGetLinkAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetLinkAttributesResponse added in v1.14.4

type BatchGetLinkAttributesResponse struct {

	// The attributes that are associated with the typed link.
	Attributes []*AttributeKeyAndValue `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a GetLinkAttributes response operation.

func (BatchGetLinkAttributesResponse) GoString added in v1.14.4

GoString returns the string representation

func (*BatchGetLinkAttributesResponse) SetAttributes added in v1.14.4

SetAttributes sets the Attributes field's value.

func (BatchGetLinkAttributesResponse) String added in v1.14.4

String returns the string representation

type BatchGetObjectAttributes added in v1.13.31

type BatchGetObjectAttributes struct {

	// List of attribute names whose values will be retrieved.
	//
	// AttributeNames is a required field
	AttributeNames []*string `type:"list" required:"true"`

	// Reference that identifies the object whose attributes will be retrieved.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifier for the facet whose attributes will be retrieved. See SchemaFacet
	// for details.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// 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.

func (BatchGetObjectAttributes) GoString added in v1.13.31

func (s BatchGetObjectAttributes) GoString() string

GoString returns the string representation

func (*BatchGetObjectAttributes) SetAttributeNames added in v1.13.31

func (s *BatchGetObjectAttributes) SetAttributeNames(v []*string) *BatchGetObjectAttributes

SetAttributeNames sets the AttributeNames field's value.

func (*BatchGetObjectAttributes) SetObjectReference added in v1.13.31

SetObjectReference sets the ObjectReference field's value.

func (*BatchGetObjectAttributes) SetSchemaFacet added in v1.13.31

SetSchemaFacet sets the SchemaFacet field's value.

func (BatchGetObjectAttributes) String added in v1.13.31

func (s BatchGetObjectAttributes) String() string

String returns the string representation

func (*BatchGetObjectAttributes) Validate added in v1.13.31

func (s *BatchGetObjectAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetObjectAttributesResponse added in v1.13.31

type BatchGetObjectAttributesResponse struct {

	// The attribute values that are associated with an object.
	Attributes []*AttributeKeyAndValue `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a GetObjectAttributes response operation.

func (BatchGetObjectAttributesResponse) GoString added in v1.13.31

GoString returns the string representation

func (*BatchGetObjectAttributesResponse) SetAttributes added in v1.13.31

SetAttributes sets the Attributes field's value.

func (BatchGetObjectAttributesResponse) String added in v1.13.31

String returns the string representation

type BatchGetObjectInformation added in v1.10.16

type BatchGetObjectInformation struct {

	// A reference to the object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (BatchGetObjectInformation) GoString added in v1.10.16

func (s BatchGetObjectInformation) GoString() string

GoString returns the string representation

func (*BatchGetObjectInformation) SetObjectReference added in v1.10.16

SetObjectReference sets the ObjectReference field's value.

func (BatchGetObjectInformation) String added in v1.10.16

func (s BatchGetObjectInformation) String() string

String returns the string representation

func (*BatchGetObjectInformation) Validate added in v1.10.16

func (s *BatchGetObjectInformation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchGetObjectInformationResponse added in v1.10.16

type BatchGetObjectInformationResponse struct {

	// The ObjectIdentifier of the specified object.
	ObjectIdentifier *string `type:"string"`

	// The facets attached to the specified object.
	SchemaFacets []*SchemaFacet `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a GetObjectInformation response operation.

func (BatchGetObjectInformationResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchGetObjectInformationResponse) SetObjectIdentifier added in v1.10.16

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (*BatchGetObjectInformationResponse) SetSchemaFacets added in v1.10.16

SetSchemaFacets sets the SchemaFacets field's value.

func (BatchGetObjectInformationResponse) String added in v1.10.16

String returns the string representation

type BatchListAttachedIndices added in v1.10.16

type BatchListAttachedIndices struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// A reference to the object that has indices attached.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (BatchListAttachedIndices) GoString added in v1.10.16

func (s BatchListAttachedIndices) GoString() string

GoString returns the string representation

func (*BatchListAttachedIndices) SetMaxResults added in v1.10.16

SetMaxResults sets the MaxResults field's value.

func (*BatchListAttachedIndices) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListAttachedIndices) SetTargetReference added in v1.10.16

SetTargetReference sets the TargetReference field's value.

func (BatchListAttachedIndices) String added in v1.10.16

func (s BatchListAttachedIndices) String() string

String returns the string representation

func (*BatchListAttachedIndices) Validate added in v1.10.16

func (s *BatchListAttachedIndices) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListAttachedIndicesResponse added in v1.10.16

type BatchListAttachedIndicesResponse struct {

	// The indices attached to the specified object.
	IndexAttachments []*IndexAttachment `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a ListAttachedIndices response operation.

func (BatchListAttachedIndicesResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchListAttachedIndicesResponse) SetIndexAttachments added in v1.10.16

SetIndexAttachments sets the IndexAttachments field's value.

func (*BatchListAttachedIndicesResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (BatchListAttachedIndicesResponse) String added in v1.10.16

String returns the string representation

type BatchListIncomingTypedLinks struct {

	// 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 `type:"list"`

	// 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 `type:"structure"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchListIncomingTypedLinks) GoString added in v1.10.16

func (s BatchListIncomingTypedLinks) GoString() string

GoString returns the string representation

func (*BatchListIncomingTypedLinks) SetFilterAttributeRanges added in v1.10.16

SetFilterAttributeRanges sets the FilterAttributeRanges field's value.

SetFilterTypedLink sets the FilterTypedLink field's value.

func (*BatchListIncomingTypedLinks) SetMaxResults added in v1.10.16

SetMaxResults sets the MaxResults field's value.

func (*BatchListIncomingTypedLinks) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListIncomingTypedLinks) SetObjectReference added in v1.10.16

SetObjectReference sets the ObjectReference field's value.

func (BatchListIncomingTypedLinks) String added in v1.10.16

String returns the string representation

func (*BatchListIncomingTypedLinks) Validate added in v1.10.16

func (s *BatchListIncomingTypedLinks) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListIncomingTypedLinksResponse added in v1.10.16

type BatchListIncomingTypedLinksResponse struct {

	// Returns one or more typed link specifiers as output.
	LinkSpecifiers []*TypedLinkSpecifier `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a ListIncomingTypedLinks response operation.

func (BatchListIncomingTypedLinksResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchListIncomingTypedLinksResponse) SetLinkSpecifiers added in v1.10.16

SetLinkSpecifiers sets the LinkSpecifiers field's value.

func (*BatchListIncomingTypedLinksResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (BatchListIncomingTypedLinksResponse) String added in v1.10.16

String returns the string representation

type BatchListIndex added in v1.10.16

type BatchListIndex struct {

	// The reference to the index to list.
	//
	// IndexReference is a required field
	IndexReference *ObjectReference `type:"structure" required:"true"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Specifies the ranges of indexed values that you want to query.
	RangesOnIndexedValues []*ObjectAttributeRange `type:"list"`
	// contains filtered or unexported fields
}

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

func (BatchListIndex) GoString added in v1.10.16

func (s BatchListIndex) GoString() string

GoString returns the string representation

func (*BatchListIndex) SetIndexReference added in v1.10.16

func (s *BatchListIndex) SetIndexReference(v *ObjectReference) *BatchListIndex

SetIndexReference sets the IndexReference field's value.

func (*BatchListIndex) SetMaxResults added in v1.10.16

func (s *BatchListIndex) SetMaxResults(v int64) *BatchListIndex

SetMaxResults sets the MaxResults field's value.

func (*BatchListIndex) SetNextToken added in v1.10.16

func (s *BatchListIndex) SetNextToken(v string) *BatchListIndex

SetNextToken sets the NextToken field's value.

func (*BatchListIndex) SetRangesOnIndexedValues added in v1.10.16

func (s *BatchListIndex) SetRangesOnIndexedValues(v []*ObjectAttributeRange) *BatchListIndex

SetRangesOnIndexedValues sets the RangesOnIndexedValues field's value.

func (BatchListIndex) String added in v1.10.16

func (s BatchListIndex) String() string

String returns the string representation

func (*BatchListIndex) Validate added in v1.10.16

func (s *BatchListIndex) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListIndexResponse added in v1.10.16

type BatchListIndexResponse struct {

	// The objects and indexed values attached to the index.
	IndexAttachments []*IndexAttachment `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a ListIndex response operation.

func (BatchListIndexResponse) GoString added in v1.10.16

func (s BatchListIndexResponse) GoString() string

GoString returns the string representation

func (*BatchListIndexResponse) SetIndexAttachments added in v1.10.16

func (s *BatchListIndexResponse) SetIndexAttachments(v []*IndexAttachment) *BatchListIndexResponse

SetIndexAttachments sets the IndexAttachments field's value.

func (*BatchListIndexResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (BatchListIndexResponse) String added in v1.10.16

func (s BatchListIndexResponse) String() string

String returns the string representation

type BatchListObjectAttributes

type BatchListObjectAttributes struct {

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

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Reference of the object whose attributes need to be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a ListObjectAttributes operation.

func (BatchListObjectAttributes) GoString

func (s BatchListObjectAttributes) GoString() string

GoString returns the string representation

func (*BatchListObjectAttributes) SetFacetFilter added in v1.8.6

SetFacetFilter sets the FacetFilter field's value.

func (*BatchListObjectAttributes) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*BatchListObjectAttributes) SetNextToken

SetNextToken sets the NextToken field's value.

func (*BatchListObjectAttributes) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (BatchListObjectAttributes) String

func (s BatchListObjectAttributes) String() string

String returns the string representation

func (*BatchListObjectAttributes) Validate

func (s *BatchListObjectAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a ListObjectAttributes response operation.

func (BatchListObjectAttributesResponse) GoString

GoString returns the string representation

func (*BatchListObjectAttributesResponse) SetAttributes

SetAttributes sets the Attributes field's value.

func (*BatchListObjectAttributesResponse) SetNextToken

SetNextToken sets the NextToken field's value.

func (BatchListObjectAttributesResponse) String

String returns the string representation

type BatchListObjectChildren

type BatchListObjectChildren struct {

	// Maximum number of items to be retrieved in a single call. This is an approximate
	// number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Reference of the object for which child objects are being listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a ListObjectChildren operation.

func (BatchListObjectChildren) GoString

func (s BatchListObjectChildren) GoString() string

GoString returns the string representation

func (*BatchListObjectChildren) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*BatchListObjectChildren) SetNextToken

SetNextToken sets the NextToken field's value.

func (*BatchListObjectChildren) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (BatchListObjectChildren) String

func (s BatchListObjectChildren) String() string

String returns the string representation

func (*BatchListObjectChildren) Validate

func (s *BatchListObjectChildren) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 `type:"map"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a ListObjectChildren response operation.

func (BatchListObjectChildrenResponse) GoString

GoString returns the string representation

func (*BatchListObjectChildrenResponse) SetChildren

SetChildren sets the Children field's value.

func (*BatchListObjectChildrenResponse) SetNextToken

SetNextToken sets the NextToken field's value.

func (BatchListObjectChildrenResponse) String

String returns the string representation

type BatchListObjectParentPaths added in v1.10.16

type BatchListObjectParentPaths struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchListObjectParentPaths) GoString added in v1.10.16

func (s BatchListObjectParentPaths) GoString() string

GoString returns the string representation

func (*BatchListObjectParentPaths) SetMaxResults added in v1.10.16

SetMaxResults sets the MaxResults field's value.

func (*BatchListObjectParentPaths) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListObjectParentPaths) SetObjectReference added in v1.10.16

SetObjectReference sets the ObjectReference field's value.

func (BatchListObjectParentPaths) String added in v1.10.16

String returns the string representation

func (*BatchListObjectParentPaths) Validate added in v1.10.16

func (s *BatchListObjectParentPaths) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListObjectParentPathsResponse added in v1.10.16

type BatchListObjectParentPathsResponse struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// Returns the path to the ObjectIdentifiers that are associated with the directory.
	PathToObjectIdentifiersList []*PathToObjectIdentifiers `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a ListObjectParentPaths response operation.

func (BatchListObjectParentPathsResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchListObjectParentPathsResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListObjectParentPathsResponse) SetPathToObjectIdentifiersList added in v1.10.16

SetPathToObjectIdentifiersList sets the PathToObjectIdentifiersList field's value.

func (BatchListObjectParentPathsResponse) String added in v1.10.16

String returns the string representation

type BatchListObjectParents added in v1.15.68

type BatchListObjectParents struct {
	MaxResults *int64 `min:"1" type:"integer"`

	NextToken *string `type:"string"`

	// The reference that identifies an object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (BatchListObjectParents) GoString added in v1.15.68

func (s BatchListObjectParents) GoString() string

GoString returns the string representation

func (*BatchListObjectParents) SetMaxResults added in v1.15.68

SetMaxResults sets the MaxResults field's value.

func (*BatchListObjectParents) SetNextToken added in v1.15.68

SetNextToken sets the NextToken field's value.

func (*BatchListObjectParents) SetObjectReference added in v1.15.68

SetObjectReference sets the ObjectReference field's value.

func (BatchListObjectParents) String added in v1.15.68

func (s BatchListObjectParents) String() string

String returns the string representation

func (*BatchListObjectParents) Validate added in v1.15.68

func (s *BatchListObjectParents) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListObjectParentsResponse added in v1.15.68

type BatchListObjectParentsResponse struct {
	NextToken *string `type:"string"`

	ParentLinks []*ObjectIdentifierAndLinkNameTuple `type:"list"`
	// contains filtered or unexported fields
}

func (BatchListObjectParentsResponse) GoString added in v1.15.68

GoString returns the string representation

func (*BatchListObjectParentsResponse) SetNextToken added in v1.15.68

SetNextToken sets the NextToken field's value.

SetParentLinks sets the ParentLinks field's value.

func (BatchListObjectParentsResponse) String added in v1.15.68

String returns the string representation

type BatchListObjectPolicies added in v1.10.16

type BatchListObjectPolicies struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchListObjectPolicies) GoString added in v1.10.16

func (s BatchListObjectPolicies) GoString() string

GoString returns the string representation

func (*BatchListObjectPolicies) SetMaxResults added in v1.10.16

SetMaxResults sets the MaxResults field's value.

func (*BatchListObjectPolicies) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListObjectPolicies) SetObjectReference added in v1.10.16

SetObjectReference sets the ObjectReference field's value.

func (BatchListObjectPolicies) String added in v1.10.16

func (s BatchListObjectPolicies) String() string

String returns the string representation

func (*BatchListObjectPolicies) Validate added in v1.10.16

func (s *BatchListObjectPolicies) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListObjectPoliciesResponse added in v1.10.16

type BatchListObjectPoliciesResponse struct {

	// A list of policy ObjectIdentifiers, that are attached to the object.
	AttachedPolicyIds []*string `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a ListObjectPolicies response operation.

func (BatchListObjectPoliciesResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchListObjectPoliciesResponse) SetAttachedPolicyIds added in v1.10.16

SetAttachedPolicyIds sets the AttachedPolicyIds field's value.

func (*BatchListObjectPoliciesResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (BatchListObjectPoliciesResponse) String added in v1.10.16

String returns the string representation

type BatchListOutgoingTypedLinks struct {

	// 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 `type:"list"`

	// 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 `type:"structure"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchListOutgoingTypedLinks) GoString added in v1.10.16

func (s BatchListOutgoingTypedLinks) GoString() string

GoString returns the string representation

func (*BatchListOutgoingTypedLinks) SetFilterAttributeRanges added in v1.10.16

SetFilterAttributeRanges sets the FilterAttributeRanges field's value.

SetFilterTypedLink sets the FilterTypedLink field's value.

func (*BatchListOutgoingTypedLinks) SetMaxResults added in v1.10.16

SetMaxResults sets the MaxResults field's value.

func (*BatchListOutgoingTypedLinks) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListOutgoingTypedLinks) SetObjectReference added in v1.10.16

SetObjectReference sets the ObjectReference field's value.

func (BatchListOutgoingTypedLinks) String added in v1.10.16

String returns the string representation

func (*BatchListOutgoingTypedLinks) Validate added in v1.10.16

func (s *BatchListOutgoingTypedLinks) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListOutgoingTypedLinksResponse added in v1.10.16

type BatchListOutgoingTypedLinksResponse struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// Returns a typed link specifier as output.
	TypedLinkSpecifiers []*TypedLinkSpecifier `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a ListOutgoingTypedLinks response operation.

func (BatchListOutgoingTypedLinksResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchListOutgoingTypedLinksResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListOutgoingTypedLinksResponse) SetTypedLinkSpecifiers added in v1.10.16

SetTypedLinkSpecifiers sets the TypedLinkSpecifiers field's value.

func (BatchListOutgoingTypedLinksResponse) String added in v1.10.16

String returns the string representation

type BatchListPolicyAttachments added in v1.10.16

type BatchListPolicyAttachments struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchListPolicyAttachments) GoString added in v1.10.16

func (s BatchListPolicyAttachments) GoString() string

GoString returns the string representation

func (*BatchListPolicyAttachments) SetMaxResults added in v1.10.16

SetMaxResults sets the MaxResults field's value.

func (*BatchListPolicyAttachments) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListPolicyAttachments) SetPolicyReference added in v1.10.16

SetPolicyReference sets the PolicyReference field's value.

func (BatchListPolicyAttachments) String added in v1.10.16

String returns the string representation

func (*BatchListPolicyAttachments) Validate added in v1.10.16

func (s *BatchListPolicyAttachments) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchListPolicyAttachmentsResponse added in v1.10.16

type BatchListPolicyAttachmentsResponse struct {

	// The pagination token.
	NextToken *string `type:"string"`

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

Represents the output of a ListPolicyAttachments response operation.

func (BatchListPolicyAttachmentsResponse) GoString added in v1.10.16

GoString returns the string representation

func (*BatchListPolicyAttachmentsResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchListPolicyAttachmentsResponse) SetObjectIdentifiers added in v1.10.16

SetObjectIdentifiers sets the ObjectIdentifiers field's value.

func (BatchListPolicyAttachmentsResponse) String added in v1.10.16

String returns the string representation

type BatchLookupPolicy added in v1.10.16

type BatchLookupPolicy struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Reference that identifies the object whose policies will be looked up.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// 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.

func (BatchLookupPolicy) GoString added in v1.10.16

func (s BatchLookupPolicy) GoString() string

GoString returns the string representation

func (*BatchLookupPolicy) SetMaxResults added in v1.10.16

func (s *BatchLookupPolicy) SetMaxResults(v int64) *BatchLookupPolicy

SetMaxResults sets the MaxResults field's value.

func (*BatchLookupPolicy) SetNextToken added in v1.10.16

func (s *BatchLookupPolicy) SetNextToken(v string) *BatchLookupPolicy

SetNextToken sets the NextToken field's value.

func (*BatchLookupPolicy) SetObjectReference added in v1.10.16

func (s *BatchLookupPolicy) SetObjectReference(v *ObjectReference) *BatchLookupPolicy

SetObjectReference sets the ObjectReference field's value.

func (BatchLookupPolicy) String added in v1.10.16

func (s BatchLookupPolicy) String() string

String returns the string representation

func (*BatchLookupPolicy) Validate added in v1.10.16

func (s *BatchLookupPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchLookupPolicyResponse added in v1.10.16

type BatchLookupPolicyResponse struct {

	// The pagination token.
	NextToken *string `type:"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 `type:"list"`
	// contains filtered or unexported fields
}

Represents the output of a LookupPolicy response operation.

func (BatchLookupPolicyResponse) GoString added in v1.10.16

func (s BatchLookupPolicyResponse) GoString() string

GoString returns the string representation

func (*BatchLookupPolicyResponse) SetNextToken added in v1.10.16

SetNextToken sets the NextToken field's value.

func (*BatchLookupPolicyResponse) SetPolicyToPathList added in v1.10.16

SetPolicyToPathList sets the PolicyToPathList field's value.

func (BatchLookupPolicyResponse) String added in v1.10.16

func (s BatchLookupPolicyResponse) String() string

String returns the string representation

type BatchReadException

type BatchReadException struct {

	// An exception message that is associated with the failure.
	Message *string `type:"string"`

	// A type of exception, such as InvalidArnException.
	Type *string `type:"string" enum:"BatchReadExceptionType"`
	// contains filtered or unexported fields
}

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

func (BatchReadException) GoString

func (s BatchReadException) GoString() string

GoString returns the string representation

func (*BatchReadException) SetMessage

func (s *BatchReadException) SetMessage(v string) *BatchReadException

SetMessage sets the Message field's value.

func (*BatchReadException) SetType

SetType sets the Type field's value.

func (BatchReadException) String

func (s BatchReadException) String() string

String returns the string representation

type BatchReadInput

type BatchReadInput struct {

	// 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.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory. For
	// more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A list of operations that are part of the batch.
	//
	// Operations is a required field
	Operations []*BatchReadOperation `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchReadInput) GoString

func (s BatchReadInput) GoString() string

GoString returns the string representation

func (*BatchReadInput) SetConsistencyLevel

func (s *BatchReadInput) SetConsistencyLevel(v string) *BatchReadInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*BatchReadInput) SetDirectoryArn

func (s *BatchReadInput) SetDirectoryArn(v string) *BatchReadInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*BatchReadInput) SetOperations

func (s *BatchReadInput) SetOperations(v []*BatchReadOperation) *BatchReadInput

SetOperations sets the Operations field's value.

func (BatchReadInput) String

func (s BatchReadInput) String() string

String returns the string representation

func (*BatchReadInput) Validate

func (s *BatchReadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchReadOperation

type BatchReadOperation struct {

	// Retrieves attributes that are associated with a typed link.
	GetLinkAttributes *BatchGetLinkAttributes `type:"structure"`

	// Retrieves attributes within a facet that are associated with an object.
	GetObjectAttributes *BatchGetObjectAttributes `type:"structure"`

	// Retrieves metadata about an object.
	GetObjectInformation *BatchGetObjectInformation `type:"structure"`

	// Lists indices attached to an object.
	ListAttachedIndices *BatchListAttachedIndices `type:"structure"`

	// 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 `type:"structure"`

	// Lists objects attached to the specified index.
	ListIndex *BatchListIndex `type:"structure"`

	// Lists all attributes that are associated with an object.
	ListObjectAttributes *BatchListObjectAttributes `type:"structure"`

	// Returns a paginated list of child objects that are associated with a given
	// object.
	ListObjectChildren *BatchListObjectChildren `type:"structure"`

	// 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 `type:"structure"`

	ListObjectParents *BatchListObjectParents `type:"structure"`

	// Returns policies attached to an object in pagination fashion.
	ListObjectPolicies *BatchListObjectPolicies `type:"structure"`

	// 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 `type:"structure"`

	// Returns all of the ObjectIdentifiers to which a given policy is attached.
	ListPolicyAttachments *BatchListPolicyAttachments `type:"structure"`

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a BatchRead operation.

func (BatchReadOperation) GoString

func (s BatchReadOperation) GoString() string

GoString returns the string representation

func (*BatchReadOperation) SetGetLinkAttributes added in v1.14.4

func (s *BatchReadOperation) SetGetLinkAttributes(v *BatchGetLinkAttributes) *BatchReadOperation

SetGetLinkAttributes sets the GetLinkAttributes field's value.

func (*BatchReadOperation) SetGetObjectAttributes added in v1.13.31

func (s *BatchReadOperation) SetGetObjectAttributes(v *BatchGetObjectAttributes) *BatchReadOperation

SetGetObjectAttributes sets the GetObjectAttributes field's value.

func (*BatchReadOperation) SetGetObjectInformation added in v1.10.16

func (s *BatchReadOperation) SetGetObjectInformation(v *BatchGetObjectInformation) *BatchReadOperation

SetGetObjectInformation sets the GetObjectInformation field's value.

func (*BatchReadOperation) SetListAttachedIndices added in v1.10.16

func (s *BatchReadOperation) SetListAttachedIndices(v *BatchListAttachedIndices) *BatchReadOperation

SetListAttachedIndices sets the ListAttachedIndices field's value.

func (s *BatchReadOperation) SetListIncomingTypedLinks(v *BatchListIncomingTypedLinks) *BatchReadOperation

SetListIncomingTypedLinks sets the ListIncomingTypedLinks field's value.

func (*BatchReadOperation) SetListIndex added in v1.10.16

SetListIndex sets the ListIndex field's value.

func (*BatchReadOperation) SetListObjectAttributes

func (s *BatchReadOperation) SetListObjectAttributes(v *BatchListObjectAttributes) *BatchReadOperation

SetListObjectAttributes sets the ListObjectAttributes field's value.

func (*BatchReadOperation) SetListObjectChildren

func (s *BatchReadOperation) SetListObjectChildren(v *BatchListObjectChildren) *BatchReadOperation

SetListObjectChildren sets the ListObjectChildren field's value.

func (*BatchReadOperation) SetListObjectParentPaths added in v1.10.16

func (s *BatchReadOperation) SetListObjectParentPaths(v *BatchListObjectParentPaths) *BatchReadOperation

SetListObjectParentPaths sets the ListObjectParentPaths field's value.

func (*BatchReadOperation) SetListObjectParents added in v1.15.68

func (s *BatchReadOperation) SetListObjectParents(v *BatchListObjectParents) *BatchReadOperation

SetListObjectParents sets the ListObjectParents field's value.

func (*BatchReadOperation) SetListObjectPolicies added in v1.10.16

func (s *BatchReadOperation) SetListObjectPolicies(v *BatchListObjectPolicies) *BatchReadOperation

SetListObjectPolicies sets the ListObjectPolicies field's value.

func (s *BatchReadOperation) SetListOutgoingTypedLinks(v *BatchListOutgoingTypedLinks) *BatchReadOperation

SetListOutgoingTypedLinks sets the ListOutgoingTypedLinks field's value.

func (*BatchReadOperation) SetListPolicyAttachments added in v1.10.16

func (s *BatchReadOperation) SetListPolicyAttachments(v *BatchListPolicyAttachments) *BatchReadOperation

SetListPolicyAttachments sets the ListPolicyAttachments field's value.

func (*BatchReadOperation) SetLookupPolicy added in v1.10.16

SetLookupPolicy sets the LookupPolicy field's value.

func (BatchReadOperation) String

func (s BatchReadOperation) String() string

String returns the string representation

func (*BatchReadOperation) Validate

func (s *BatchReadOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchReadOperationResponse

type BatchReadOperationResponse struct {

	// Identifies which operation in a batch has failed.
	ExceptionResponse *BatchReadException `type:"structure"`

	// Identifies which operation in a batch has succeeded.
	SuccessfulResponse *BatchReadSuccessfulResponse `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a BatchRead response operation.

func (BatchReadOperationResponse) GoString

func (s BatchReadOperationResponse) GoString() string

GoString returns the string representation

func (*BatchReadOperationResponse) SetExceptionResponse

SetExceptionResponse sets the ExceptionResponse field's value.

func (*BatchReadOperationResponse) SetSuccessfulResponse

SetSuccessfulResponse sets the SuccessfulResponse field's value.

func (BatchReadOperationResponse) String

String returns the string representation

type BatchReadOutput

type BatchReadOutput struct {

	// A list of all the responses for each batch read.
	Responses []*BatchReadOperationResponse `type:"list"`
	// contains filtered or unexported fields
}

func (BatchReadOutput) GoString

func (s BatchReadOutput) GoString() string

GoString returns the string representation

func (*BatchReadOutput) SetResponses

SetResponses sets the Responses field's value.

func (BatchReadOutput) String

func (s BatchReadOutput) String() string

String returns the string representation

type BatchReadSuccessfulResponse

type BatchReadSuccessfulResponse struct {

	// The list of attributes to retrieve from the typed link.
	GetLinkAttributes *BatchGetLinkAttributesResponse `type:"structure"`

	// Retrieves attributes within a facet that are associated with an object.
	GetObjectAttributes *BatchGetObjectAttributesResponse `type:"structure"`

	// Retrieves metadata about an object.
	GetObjectInformation *BatchGetObjectInformationResponse `type:"structure"`

	// Lists indices attached to an object.
	ListAttachedIndices *BatchListAttachedIndicesResponse `type:"structure"`

	// 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 `type:"structure"`

	// Lists objects attached to the specified index.
	ListIndex *BatchListIndexResponse `type:"structure"`

	// Lists all attributes that are associated with an object.
	ListObjectAttributes *BatchListObjectAttributesResponse `type:"structure"`

	// Returns a paginated list of child objects that are associated with a given
	// object.
	ListObjectChildren *BatchListObjectChildrenResponse `type:"structure"`

	// 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 `type:"structure"`

	ListObjectParents *BatchListObjectParentsResponse `type:"structure"`

	// Returns policies attached to an object in pagination fashion.
	ListObjectPolicies *BatchListObjectPoliciesResponse `type:"structure"`

	// 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 `type:"structure"`

	// Returns all of the ObjectIdentifiers to which a given policy is attached.
	ListPolicyAttachments *BatchListPolicyAttachmentsResponse `type:"structure"`

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a BatchRead success response operation.

func (BatchReadSuccessfulResponse) GoString

func (s BatchReadSuccessfulResponse) GoString() string

GoString returns the string representation

func (*BatchReadSuccessfulResponse) SetGetLinkAttributes added in v1.14.4

SetGetLinkAttributes sets the GetLinkAttributes field's value.

func (*BatchReadSuccessfulResponse) SetGetObjectAttributes added in v1.13.31

SetGetObjectAttributes sets the GetObjectAttributes field's value.

func (*BatchReadSuccessfulResponse) SetGetObjectInformation added in v1.10.16

SetGetObjectInformation sets the GetObjectInformation field's value.

func (*BatchReadSuccessfulResponse) SetListAttachedIndices added in v1.10.16

SetListAttachedIndices sets the ListAttachedIndices field's value.

SetListIncomingTypedLinks sets the ListIncomingTypedLinks field's value.

func (*BatchReadSuccessfulResponse) SetListIndex added in v1.10.16

SetListIndex sets the ListIndex field's value.

func (*BatchReadSuccessfulResponse) SetListObjectAttributes

SetListObjectAttributes sets the ListObjectAttributes field's value.

func (*BatchReadSuccessfulResponse) SetListObjectChildren

SetListObjectChildren sets the ListObjectChildren field's value.

func (*BatchReadSuccessfulResponse) SetListObjectParentPaths added in v1.10.16

SetListObjectParentPaths sets the ListObjectParentPaths field's value.

func (*BatchReadSuccessfulResponse) SetListObjectParents added in v1.15.68

SetListObjectParents sets the ListObjectParents field's value.

func (*BatchReadSuccessfulResponse) SetListObjectPolicies added in v1.10.16

SetListObjectPolicies sets the ListObjectPolicies field's value.

SetListOutgoingTypedLinks sets the ListOutgoingTypedLinks field's value.

func (*BatchReadSuccessfulResponse) SetListPolicyAttachments added in v1.10.16

SetListPolicyAttachments sets the ListPolicyAttachments field's value.

func (*BatchReadSuccessfulResponse) SetLookupPolicy added in v1.10.16

SetLookupPolicy sets the LookupPolicy field's value.

func (BatchReadSuccessfulResponse) String

String returns the string representation

type BatchRemoveFacetFromObject

type BatchRemoveFacetFromObject struct {

	// A reference to the object whose facet will be removed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// The facet to remove from the object.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A batch operation to remove a facet from an object.

func (BatchRemoveFacetFromObject) GoString

func (s BatchRemoveFacetFromObject) GoString() string

GoString returns the string representation

func (*BatchRemoveFacetFromObject) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (*BatchRemoveFacetFromObject) SetSchemaFacet

SetSchemaFacet sets the SchemaFacet field's value.

func (BatchRemoveFacetFromObject) String

String returns the string representation

func (*BatchRemoveFacetFromObject) Validate

func (s *BatchRemoveFacetFromObject) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchRemoveFacetFromObjectResponse

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

An empty result that represents success.

func (BatchRemoveFacetFromObjectResponse) GoString

GoString returns the string representation

func (BatchRemoveFacetFromObjectResponse) String

String returns the string representation

type BatchUpdateLinkAttributes added in v1.14.4

type BatchUpdateLinkAttributes struct {

	// The attributes update structure.
	//
	// AttributeUpdates is a required field
	AttributeUpdates []*LinkAttributeUpdate `type:"list" required:"true"`

	// Allows a typed link specifier to be accepted as input.
	//
	// TypedLinkSpecifier is a required field
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure" required:"true"`
	// 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.

func (BatchUpdateLinkAttributes) GoString added in v1.14.4

func (s BatchUpdateLinkAttributes) GoString() string

GoString returns the string representation

func (*BatchUpdateLinkAttributes) SetAttributeUpdates added in v1.14.4

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*BatchUpdateLinkAttributes) SetTypedLinkSpecifier added in v1.14.4

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (BatchUpdateLinkAttributes) String added in v1.14.4

func (s BatchUpdateLinkAttributes) String() string

String returns the string representation

func (*BatchUpdateLinkAttributes) Validate added in v1.14.4

func (s *BatchUpdateLinkAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchUpdateLinkAttributesResponse added in v1.14.4

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

Represents the output of a UpdateLinkAttributes response operation.

func (BatchUpdateLinkAttributesResponse) GoString added in v1.14.4

GoString returns the string representation

func (BatchUpdateLinkAttributesResponse) String added in v1.14.4

String returns the string representation

type BatchUpdateObjectAttributes

type BatchUpdateObjectAttributes struct {

	// Attributes update structure.
	//
	// AttributeUpdates is a required field
	AttributeUpdates []*ObjectAttributeUpdate `type:"list" required:"true"`

	// Reference that identifies the object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Represents the output of a BatchUpdate operation.

func (BatchUpdateObjectAttributes) GoString

func (s BatchUpdateObjectAttributes) GoString() string

GoString returns the string representation

func (*BatchUpdateObjectAttributes) SetAttributeUpdates

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*BatchUpdateObjectAttributes) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (BatchUpdateObjectAttributes) String

String returns the string representation

func (*BatchUpdateObjectAttributes) Validate

func (s *BatchUpdateObjectAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchUpdateObjectAttributesResponse

type BatchUpdateObjectAttributesResponse struct {

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

Represents the output of a BatchUpdate response operation.

func (BatchUpdateObjectAttributesResponse) GoString

GoString returns the string representation

func (*BatchUpdateObjectAttributesResponse) SetObjectIdentifier

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (BatchUpdateObjectAttributesResponse) String

String returns the string representation

type BatchWriteInput

type BatchWriteInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory. For
	// more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A list of operations that are part of the batch.
	//
	// Operations is a required field
	Operations []*BatchWriteOperation `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (BatchWriteInput) GoString

func (s BatchWriteInput) GoString() string

GoString returns the string representation

func (*BatchWriteInput) SetDirectoryArn

func (s *BatchWriteInput) SetDirectoryArn(v string) *BatchWriteInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*BatchWriteInput) SetOperations

func (s *BatchWriteInput) SetOperations(v []*BatchWriteOperation) *BatchWriteInput

SetOperations sets the Operations field's value.

func (BatchWriteInput) String

func (s BatchWriteInput) String() string

String returns the string representation

func (*BatchWriteInput) Validate

func (s *BatchWriteInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchWriteOperation

type BatchWriteOperation struct {

	// A batch operation that adds a facet to an object.
	AddFacetToObject *BatchAddFacetToObject `type:"structure"`

	// Attaches an object to a Directory.
	AttachObject *BatchAttachObject `type:"structure"`

	// Attaches a policy object to a regular object. An object can have a limited
	// number of attached policies.
	AttachPolicy *BatchAttachPolicy `type:"structure"`

	// Attaches the specified object to the specified index.
	AttachToIndex *BatchAttachToIndex `type:"structure"`

	// 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 `type:"structure"`

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

	// Creates an object.
	CreateObject *BatchCreateObject `type:"structure"`

	// Deletes an object in a Directory.
	DeleteObject *BatchDeleteObject `type:"structure"`

	// Detaches the specified object from the specified index.
	DetachFromIndex *BatchDetachFromIndex `type:"structure"`

	// Detaches an object from a Directory.
	DetachObject *BatchDetachObject `type:"structure"`

	// Detaches a policy from a Directory.
	DetachPolicy *BatchDetachPolicy `type:"structure"`

	// 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 `type:"structure"`

	// A batch operation that removes a facet from an object.
	RemoveFacetFromObject *BatchRemoveFacetFromObject `type:"structure"`

	// Updates a given object's attributes.
	UpdateLinkAttributes *BatchUpdateLinkAttributes `type:"structure"`

	// Updates a given object's attributes.
	UpdateObjectAttributes *BatchUpdateObjectAttributes `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a BatchWrite operation.

func (BatchWriteOperation) GoString

func (s BatchWriteOperation) GoString() string

GoString returns the string representation

func (*BatchWriteOperation) SetAddFacetToObject

SetAddFacetToObject sets the AddFacetToObject field's value.

func (*BatchWriteOperation) SetAttachObject

SetAttachObject sets the AttachObject field's value.

func (*BatchWriteOperation) SetAttachPolicy added in v1.10.16

SetAttachPolicy sets the AttachPolicy field's value.

func (*BatchWriteOperation) SetAttachToIndex added in v1.10.16

SetAttachToIndex sets the AttachToIndex field's value.

SetAttachTypedLink sets the AttachTypedLink field's value.

func (*BatchWriteOperation) SetCreateIndex added in v1.10.16

SetCreateIndex sets the CreateIndex field's value.

func (*BatchWriteOperation) SetCreateObject

SetCreateObject sets the CreateObject field's value.

func (*BatchWriteOperation) SetDeleteObject

SetDeleteObject sets the DeleteObject field's value.

func (*BatchWriteOperation) SetDetachFromIndex added in v1.10.16

SetDetachFromIndex sets the DetachFromIndex field's value.

func (*BatchWriteOperation) SetDetachObject

SetDetachObject sets the DetachObject field's value.

func (*BatchWriteOperation) SetDetachPolicy added in v1.10.23

SetDetachPolicy sets the DetachPolicy field's value.

SetDetachTypedLink sets the DetachTypedLink field's value.

func (*BatchWriteOperation) SetRemoveFacetFromObject

func (s *BatchWriteOperation) SetRemoveFacetFromObject(v *BatchRemoveFacetFromObject) *BatchWriteOperation

SetRemoveFacetFromObject sets the RemoveFacetFromObject field's value.

func (*BatchWriteOperation) SetUpdateLinkAttributes added in v1.14.4

func (s *BatchWriteOperation) SetUpdateLinkAttributes(v *BatchUpdateLinkAttributes) *BatchWriteOperation

SetUpdateLinkAttributes sets the UpdateLinkAttributes field's value.

func (*BatchWriteOperation) SetUpdateObjectAttributes

func (s *BatchWriteOperation) SetUpdateObjectAttributes(v *BatchUpdateObjectAttributes) *BatchWriteOperation

SetUpdateObjectAttributes sets the UpdateObjectAttributes field's value.

func (BatchWriteOperation) String

func (s BatchWriteOperation) String() string

String returns the string representation

func (*BatchWriteOperation) Validate

func (s *BatchWriteOperation) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type BatchWriteOperationResponse

type BatchWriteOperationResponse struct {

	// The result of an add facet to object batch operation.
	AddFacetToObject *BatchAddFacetToObjectResponse `type:"structure"`

	// Attaches an object to a Directory.
	AttachObject *BatchAttachObjectResponse `type:"structure"`

	// Attaches a policy object to a regular object. An object can have a limited
	// number of attached policies.
	AttachPolicy *BatchAttachPolicyResponse `type:"structure"`

	// Attaches the specified object to the specified index.
	AttachToIndex *BatchAttachToIndexResponse `type:"structure"`

	// 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 `type:"structure"`

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

	// Creates an object in a Directory.
	CreateObject *BatchCreateObjectResponse `type:"structure"`

	// Deletes an object in a Directory.
	DeleteObject *BatchDeleteObjectResponse `type:"structure"`

	// Detaches the specified object from the specified index.
	DetachFromIndex *BatchDetachFromIndexResponse `type:"structure"`

	// Detaches an object from a Directory.
	DetachObject *BatchDetachObjectResponse `type:"structure"`

	// Detaches a policy from a Directory.
	DetachPolicy *BatchDetachPolicyResponse `type:"structure"`

	// 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 `type:"structure"`

	// The result of a batch remove facet from object operation.
	RemoveFacetFromObject *BatchRemoveFacetFromObjectResponse `type:"structure"`

	// Represents the output of a BatchWrite response operation.
	UpdateLinkAttributes *BatchUpdateLinkAttributesResponse `type:"structure"`

	// Updates a given object’s attributes.
	UpdateObjectAttributes *BatchUpdateObjectAttributesResponse `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a BatchWrite response operation.

func (BatchWriteOperationResponse) GoString

func (s BatchWriteOperationResponse) GoString() string

GoString returns the string representation

func (*BatchWriteOperationResponse) SetAddFacetToObject

SetAddFacetToObject sets the AddFacetToObject field's value.

func (*BatchWriteOperationResponse) SetAttachObject

SetAttachObject sets the AttachObject field's value.

func (*BatchWriteOperationResponse) SetAttachPolicy added in v1.10.16

SetAttachPolicy sets the AttachPolicy field's value.

func (*BatchWriteOperationResponse) SetAttachToIndex added in v1.10.16

SetAttachToIndex sets the AttachToIndex field's value.

SetAttachTypedLink sets the AttachTypedLink field's value.

func (*BatchWriteOperationResponse) SetCreateIndex added in v1.10.16

SetCreateIndex sets the CreateIndex field's value.

func (*BatchWriteOperationResponse) SetCreateObject

SetCreateObject sets the CreateObject field's value.

func (*BatchWriteOperationResponse) SetDeleteObject

SetDeleteObject sets the DeleteObject field's value.

func (*BatchWriteOperationResponse) SetDetachFromIndex added in v1.10.16

SetDetachFromIndex sets the DetachFromIndex field's value.

func (*BatchWriteOperationResponse) SetDetachObject

SetDetachObject sets the DetachObject field's value.

func (*BatchWriteOperationResponse) SetDetachPolicy added in v1.10.23

SetDetachPolicy sets the DetachPolicy field's value.

SetDetachTypedLink sets the DetachTypedLink field's value.

func (*BatchWriteOperationResponse) SetRemoveFacetFromObject

SetRemoveFacetFromObject sets the RemoveFacetFromObject field's value.

func (*BatchWriteOperationResponse) SetUpdateLinkAttributes added in v1.14.4

SetUpdateLinkAttributes sets the UpdateLinkAttributes field's value.

func (*BatchWriteOperationResponse) SetUpdateObjectAttributes

SetUpdateObjectAttributes sets the UpdateObjectAttributes field's value.

func (BatchWriteOperationResponse) String

String returns the string representation

type BatchWriteOutput

type BatchWriteOutput struct {

	// A list of all the responses for each batch write.
	Responses []*BatchWriteOperationResponse `type:"list"`
	// contains filtered or unexported fields
}

func (BatchWriteOutput) GoString

func (s BatchWriteOutput) GoString() string

GoString returns the string representation

func (*BatchWriteOutput) SetResponses

SetResponses sets the Responses field's value.

func (BatchWriteOutput) String

func (s BatchWriteOutput) String() string

String returns the string representation

type CloudDirectory

type CloudDirectory struct {
	*client.Client
}

CloudDirectory provides the API operation methods for making requests to Amazon CloudDirectory. See this package's package overview docs for details on the service.

CloudDirectory methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudDirectory

New creates a new instance of the CloudDirectory client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a CloudDirectory client from just a session.
svc := clouddirectory.New(mySession)

// Create a CloudDirectory client with additional configuration
svc := clouddirectory.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudDirectory) AddFacetToObject

func (c *CloudDirectory) AddFacetToObject(input *AddFacetToObjectInput) (*AddFacetToObjectOutput, error)

AddFacetToObject API operation for Amazon CloudDirectory.

Adds a new Facet to an object. An object can have more than one facet applied on it.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation AddFacetToObject for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AddFacetToObject

func (*CloudDirectory) AddFacetToObjectRequest

func (c *CloudDirectory) AddFacetToObjectRequest(input *AddFacetToObjectInput) (req *request.Request, output *AddFacetToObjectOutput)

AddFacetToObjectRequest generates a "aws/request.Request" representing the client's request for the AddFacetToObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AddFacetToObject for more information on using the AddFacetToObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AddFacetToObjectRequest method.
req, resp := client.AddFacetToObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AddFacetToObject

func (*CloudDirectory) AddFacetToObjectWithContext added in v1.8.0

func (c *CloudDirectory) AddFacetToObjectWithContext(ctx aws.Context, input *AddFacetToObjectInput, opts ...request.Option) (*AddFacetToObjectOutput, error)

AddFacetToObjectWithContext is the same as AddFacetToObject with the addition of the ability to pass a context and additional request options.

See AddFacetToObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ApplySchema

func (c *CloudDirectory) ApplySchema(input *ApplySchemaInput) (*ApplySchemaOutput, error)

ApplySchema API operation for Amazon CloudDirectory.

Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ApplySchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ApplySchema

func (*CloudDirectory) ApplySchemaRequest

func (c *CloudDirectory) ApplySchemaRequest(input *ApplySchemaInput) (req *request.Request, output *ApplySchemaOutput)

ApplySchemaRequest generates a "aws/request.Request" representing the client's request for the ApplySchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ApplySchema for more information on using the ApplySchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ApplySchemaRequest method.
req, resp := client.ApplySchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ApplySchema

func (*CloudDirectory) ApplySchemaWithContext added in v1.8.0

func (c *CloudDirectory) ApplySchemaWithContext(ctx aws.Context, input *ApplySchemaInput, opts ...request.Option) (*ApplySchemaOutput, error)

ApplySchemaWithContext is the same as ApplySchema with the addition of the ability to pass a context and additional request options.

See ApplySchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) AttachObject

func (c *CloudDirectory) AttachObject(input *AttachObjectInput) (*AttachObjectOutput, error)

AttachObject API operation for Amazon CloudDirectory.

Attaches an existing object to another object. An object can be accessed in two ways:

Using the path

Using ObjectIdentifier

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation AttachObject for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachObject

func (*CloudDirectory) AttachObjectRequest

func (c *CloudDirectory) AttachObjectRequest(input *AttachObjectInput) (req *request.Request, output *AttachObjectOutput)

AttachObjectRequest generates a "aws/request.Request" representing the client's request for the AttachObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachObject for more information on using the AttachObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachObjectRequest method.
req, resp := client.AttachObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachObject

func (*CloudDirectory) AttachObjectWithContext added in v1.8.0

func (c *CloudDirectory) AttachObjectWithContext(ctx aws.Context, input *AttachObjectInput, opts ...request.Option) (*AttachObjectOutput, error)

AttachObjectWithContext is the same as AttachObject with the addition of the ability to pass a context and additional request options.

See AttachObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) AttachPolicy

func (c *CloudDirectory) AttachPolicy(input *AttachPolicyInput) (*AttachPolicyOutput, error)

AttachPolicy API operation for Amazon CloudDirectory.

Attaches a policy object to a regular object. An object can have a limited number of attached policies.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation AttachPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeNotPolicyException "NotPolicyException" Indicates that the requested operation can only operate on policy objects.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachPolicy

func (*CloudDirectory) AttachPolicyRequest

func (c *CloudDirectory) AttachPolicyRequest(input *AttachPolicyInput) (req *request.Request, output *AttachPolicyOutput)

AttachPolicyRequest generates a "aws/request.Request" representing the client's request for the AttachPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachPolicy for more information on using the AttachPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachPolicyRequest method.
req, resp := client.AttachPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachPolicy

func (*CloudDirectory) AttachPolicyWithContext added in v1.8.0

func (c *CloudDirectory) AttachPolicyWithContext(ctx aws.Context, input *AttachPolicyInput, opts ...request.Option) (*AttachPolicyOutput, error)

AttachPolicyWithContext is the same as AttachPolicy with the addition of the ability to pass a context and additional request options.

See AttachPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) AttachToIndex

func (c *CloudDirectory) AttachToIndex(input *AttachToIndexInput) (*AttachToIndexOutput, error)

AttachToIndex API operation for Amazon CloudDirectory.

Attaches the specified object to the specified index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation AttachToIndex for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" 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.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

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

  • ErrCodeNotIndexException "NotIndexException" Indicates that the requested operation can only operate on index objects.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachToIndex

func (*CloudDirectory) AttachToIndexRequest

func (c *CloudDirectory) AttachToIndexRequest(input *AttachToIndexInput) (req *request.Request, output *AttachToIndexOutput)

AttachToIndexRequest generates a "aws/request.Request" representing the client's request for the AttachToIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachToIndex for more information on using the AttachToIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachToIndexRequest method.
req, resp := client.AttachToIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachToIndex

func (*CloudDirectory) AttachToIndexWithContext added in v1.8.0

func (c *CloudDirectory) AttachToIndexWithContext(ctx aws.Context, input *AttachToIndexInput, opts ...request.Option) (*AttachToIndexOutput, error)

AttachToIndexWithContext is the same as AttachToIndex with the addition of the ability to pass a context and additional request options.

See AttachToIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (c *CloudDirectory) AttachTypedLink(input *AttachTypedLinkInput) (*AttachTypedLinkOutput, error)

AttachTypedLink API operation for Amazon CloudDirectory.

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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation AttachTypedLink for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachTypedLink

func (*CloudDirectory) AttachTypedLinkRequest added in v1.8.31

func (c *CloudDirectory) AttachTypedLinkRequest(input *AttachTypedLinkInput) (req *request.Request, output *AttachTypedLinkOutput)

AttachTypedLinkRequest generates a "aws/request.Request" representing the client's request for the AttachTypedLink operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AttachTypedLink for more information on using the AttachTypedLink API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AttachTypedLinkRequest method.
req, resp := client.AttachTypedLinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/AttachTypedLink

func (*CloudDirectory) AttachTypedLinkWithContext added in v1.8.31

func (c *CloudDirectory) AttachTypedLinkWithContext(ctx aws.Context, input *AttachTypedLinkInput, opts ...request.Option) (*AttachTypedLinkOutput, error)

AttachTypedLinkWithContext is the same as AttachTypedLink with the addition of the ability to pass a context and additional request options.

See AttachTypedLink for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) BatchRead

func (c *CloudDirectory) BatchRead(input *BatchReadInput) (*BatchReadOutput, error)

BatchRead API operation for Amazon CloudDirectory.

Performs all the read operations in a batch.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation BatchRead for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/BatchRead

func (*CloudDirectory) BatchReadRequest

func (c *CloudDirectory) BatchReadRequest(input *BatchReadInput) (req *request.Request, output *BatchReadOutput)

BatchReadRequest generates a "aws/request.Request" representing the client's request for the BatchRead operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchRead for more information on using the BatchRead API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchReadRequest method.
req, resp := client.BatchReadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/BatchRead

func (*CloudDirectory) BatchReadWithContext added in v1.8.0

func (c *CloudDirectory) BatchReadWithContext(ctx aws.Context, input *BatchReadInput, opts ...request.Option) (*BatchReadOutput, error)

BatchReadWithContext is the same as BatchRead with the addition of the ability to pass a context and additional request options.

See BatchRead for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) BatchWrite

func (c *CloudDirectory) BatchWrite(input *BatchWriteInput) (*BatchWriteOutput, error)

BatchWrite API operation for Amazon CloudDirectory.

Performs all the write operations in a batch. Either all the operations succeed or none.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation BatchWrite for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeBatchWriteException "BatchWriteException" A BatchWrite exception has occurred.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/BatchWrite

func (*CloudDirectory) BatchWriteRequest

func (c *CloudDirectory) BatchWriteRequest(input *BatchWriteInput) (req *request.Request, output *BatchWriteOutput)

BatchWriteRequest generates a "aws/request.Request" representing the client's request for the BatchWrite operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See BatchWrite for more information on using the BatchWrite API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the BatchWriteRequest method.
req, resp := client.BatchWriteRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/BatchWrite

func (*CloudDirectory) BatchWriteWithContext added in v1.8.0

func (c *CloudDirectory) BatchWriteWithContext(ctx aws.Context, input *BatchWriteInput, opts ...request.Option) (*BatchWriteOutput, error)

BatchWriteWithContext is the same as BatchWrite with the addition of the ability to pass a context and additional request options.

See BatchWrite for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) CreateDirectory

func (c *CloudDirectory) CreateDirectory(input *CreateDirectoryInput) (*CreateDirectoryOutput, error)

CreateDirectory API operation for Amazon CloudDirectory.

Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema.

You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html) in the Amazon Cloud Directory Developer Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation CreateDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateDirectory

func (*CloudDirectory) CreateDirectoryRequest

func (c *CloudDirectory) CreateDirectoryRequest(input *CreateDirectoryInput) (req *request.Request, output *CreateDirectoryOutput)

CreateDirectoryRequest generates a "aws/request.Request" representing the client's request for the CreateDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateDirectory for more information on using the CreateDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateDirectoryRequest method.
req, resp := client.CreateDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateDirectory

func (*CloudDirectory) CreateDirectoryWithContext added in v1.8.0

func (c *CloudDirectory) CreateDirectoryWithContext(ctx aws.Context, input *CreateDirectoryInput, opts ...request.Option) (*CreateDirectoryOutput, error)

CreateDirectoryWithContext is the same as CreateDirectory with the addition of the ability to pass a context and additional request options.

See CreateDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) CreateFacet

func (c *CloudDirectory) CreateFacet(input *CreateFacetInput) (*CreateFacetOutput, error)

CreateFacet API operation for Amazon CloudDirectory.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation CreateFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetAlreadyExistsException "FacetAlreadyExistsException" A facet with the same name already exists.

  • ErrCodeInvalidRuleException "InvalidRuleException" Occurs when any of the rule parameter keys or values are invalid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateFacet

func (*CloudDirectory) CreateFacetRequest

func (c *CloudDirectory) CreateFacetRequest(input *CreateFacetInput) (req *request.Request, output *CreateFacetOutput)

CreateFacetRequest generates a "aws/request.Request" representing the client's request for the CreateFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFacet for more information on using the CreateFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFacetRequest method.
req, resp := client.CreateFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateFacet

func (*CloudDirectory) CreateFacetWithContext added in v1.8.0

func (c *CloudDirectory) CreateFacetWithContext(ctx aws.Context, input *CreateFacetInput, opts ...request.Option) (*CreateFacetOutput, error)

CreateFacetWithContext is the same as CreateFacet with the addition of the ability to pass a context and additional request options.

See CreateFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) CreateIndex

func (c *CloudDirectory) CreateIndex(input *CreateIndexInput) (*CreateIndexOutput, error)

CreateIndex API operation for Amazon CloudDirectory.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation CreateIndex for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

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

  • ErrCodeUnsupportedIndexTypeException "UnsupportedIndexTypeException" Indicates that the requested index type is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateIndex

func (*CloudDirectory) CreateIndexRequest

func (c *CloudDirectory) CreateIndexRequest(input *CreateIndexInput) (req *request.Request, output *CreateIndexOutput)

CreateIndexRequest generates a "aws/request.Request" representing the client's request for the CreateIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateIndex for more information on using the CreateIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateIndexRequest method.
req, resp := client.CreateIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateIndex

func (*CloudDirectory) CreateIndexWithContext added in v1.8.0

func (c *CloudDirectory) CreateIndexWithContext(ctx aws.Context, input *CreateIndexInput, opts ...request.Option) (*CreateIndexOutput, error)

CreateIndexWithContext is the same as CreateIndex with the addition of the ability to pass a context and additional request options.

See CreateIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) CreateObject

func (c *CloudDirectory) CreateObject(input *CreateObjectInput) (*CreateObjectOutput, error)

CreateObject API operation for Amazon CloudDirectory.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation CreateObject for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

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

  • ErrCodeUnsupportedIndexTypeException "UnsupportedIndexTypeException" Indicates that the requested index type is not supported.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateObject

func (*CloudDirectory) CreateObjectRequest

func (c *CloudDirectory) CreateObjectRequest(input *CreateObjectInput) (req *request.Request, output *CreateObjectOutput)

CreateObjectRequest generates a "aws/request.Request" representing the client's request for the CreateObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateObject for more information on using the CreateObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateObjectRequest method.
req, resp := client.CreateObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateObject

func (*CloudDirectory) CreateObjectWithContext added in v1.8.0

func (c *CloudDirectory) CreateObjectWithContext(ctx aws.Context, input *CreateObjectInput, opts ...request.Option) (*CreateObjectOutput, error)

CreateObjectWithContext is the same as CreateObject with the addition of the ability to pass a context and additional request options.

See CreateObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) CreateSchema

func (c *CloudDirectory) CreateSchema(input *CreateSchemaInput) (*CreateSchemaOutput, error)

CreateSchema API operation for Amazon CloudDirectory.

Creates a new schema in a development state. A schema can exist in three phases:

  • Development: This is a mutable phase of the schema. All new schemas are in the development phase. Once the schema is finalized, it can be published.

  • Published: Published schemas are immutable and have a version associated with them.

  • Applied: Applied schemas are mutable in a way that allows you to add new schema facets. You can also add new, nonrequired attributes to existing schema facets. You can apply only published schemas to directories.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation CreateSchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateSchema

func (*CloudDirectory) CreateSchemaRequest

func (c *CloudDirectory) CreateSchemaRequest(input *CreateSchemaInput) (req *request.Request, output *CreateSchemaOutput)

CreateSchemaRequest generates a "aws/request.Request" representing the client's request for the CreateSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateSchema for more information on using the CreateSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateSchemaRequest method.
req, resp := client.CreateSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateSchema

func (*CloudDirectory) CreateSchemaWithContext added in v1.8.0

func (c *CloudDirectory) CreateSchemaWithContext(ctx aws.Context, input *CreateSchemaInput, opts ...request.Option) (*CreateSchemaOutput, error)

CreateSchemaWithContext is the same as CreateSchema with the addition of the ability to pass a context and additional request options.

See CreateSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) CreateTypedLinkFacet added in v1.8.31

func (c *CloudDirectory) CreateTypedLinkFacet(input *CreateTypedLinkFacetInput) (*CreateTypedLinkFacetOutput, error)

CreateTypedLinkFacet API operation for Amazon CloudDirectory.

Creates a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation CreateTypedLinkFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetAlreadyExistsException "FacetAlreadyExistsException" A facet with the same name already exists.

  • ErrCodeInvalidRuleException "InvalidRuleException" Occurs when any of the rule parameter keys or values are invalid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateTypedLinkFacet

func (*CloudDirectory) CreateTypedLinkFacetRequest added in v1.8.31

func (c *CloudDirectory) CreateTypedLinkFacetRequest(input *CreateTypedLinkFacetInput) (req *request.Request, output *CreateTypedLinkFacetOutput)

CreateTypedLinkFacetRequest generates a "aws/request.Request" representing the client's request for the CreateTypedLinkFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateTypedLinkFacet for more information on using the CreateTypedLinkFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateTypedLinkFacetRequest method.
req, resp := client.CreateTypedLinkFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/CreateTypedLinkFacet

func (*CloudDirectory) CreateTypedLinkFacetWithContext added in v1.8.31

func (c *CloudDirectory) CreateTypedLinkFacetWithContext(ctx aws.Context, input *CreateTypedLinkFacetInput, opts ...request.Option) (*CreateTypedLinkFacetOutput, error)

CreateTypedLinkFacetWithContext is the same as CreateTypedLinkFacet with the addition of the ability to pass a context and additional request options.

See CreateTypedLinkFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DeleteDirectory

func (c *CloudDirectory) DeleteDirectory(input *DeleteDirectoryInput) (*DeleteDirectoryOutput, error)

DeleteDirectory API operation for Amazon CloudDirectory.

Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DeleteDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeDirectoryNotDisabledException "DirectoryNotDisabledException" An operation can only operate on a disabled directory.

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

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

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteDirectory

func (*CloudDirectory) DeleteDirectoryRequest

func (c *CloudDirectory) DeleteDirectoryRequest(input *DeleteDirectoryInput) (req *request.Request, output *DeleteDirectoryOutput)

DeleteDirectoryRequest generates a "aws/request.Request" representing the client's request for the DeleteDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteDirectory for more information on using the DeleteDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteDirectoryRequest method.
req, resp := client.DeleteDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteDirectory

func (*CloudDirectory) DeleteDirectoryWithContext added in v1.8.0

func (c *CloudDirectory) DeleteDirectoryWithContext(ctx aws.Context, input *DeleteDirectoryInput, opts ...request.Option) (*DeleteDirectoryOutput, error)

DeleteDirectoryWithContext is the same as DeleteDirectory with the addition of the ability to pass a context and additional request options.

See DeleteDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DeleteFacet

func (c *CloudDirectory) DeleteFacet(input *DeleteFacetInput) (*DeleteFacetOutput, error)

DeleteFacet API operation for Amazon CloudDirectory.

Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DeleteFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteFacet

func (*CloudDirectory) DeleteFacetRequest

func (c *CloudDirectory) DeleteFacetRequest(input *DeleteFacetInput) (req *request.Request, output *DeleteFacetOutput)

DeleteFacetRequest generates a "aws/request.Request" representing the client's request for the DeleteFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFacet for more information on using the DeleteFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFacetRequest method.
req, resp := client.DeleteFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteFacet

func (*CloudDirectory) DeleteFacetWithContext added in v1.8.0

func (c *CloudDirectory) DeleteFacetWithContext(ctx aws.Context, input *DeleteFacetInput, opts ...request.Option) (*DeleteFacetOutput, error)

DeleteFacetWithContext is the same as DeleteFacet with the addition of the ability to pass a context and additional request options.

See DeleteFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DeleteObject

func (c *CloudDirectory) DeleteObject(input *DeleteObjectInput) (*DeleteObjectOutput, error)

DeleteObject API operation for Amazon CloudDirectory.

Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DeleteObject for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteObject

func (*CloudDirectory) DeleteObjectRequest

func (c *CloudDirectory) DeleteObjectRequest(input *DeleteObjectInput) (req *request.Request, output *DeleteObjectOutput)

DeleteObjectRequest generates a "aws/request.Request" representing the client's request for the DeleteObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteObject for more information on using the DeleteObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteObjectRequest method.
req, resp := client.DeleteObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteObject

func (*CloudDirectory) DeleteObjectWithContext added in v1.8.0

func (c *CloudDirectory) DeleteObjectWithContext(ctx aws.Context, input *DeleteObjectInput, opts ...request.Option) (*DeleteObjectOutput, error)

DeleteObjectWithContext is the same as DeleteObject with the addition of the ability to pass a context and additional request options.

See DeleteObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DeleteSchema

func (c *CloudDirectory) DeleteSchema(input *DeleteSchemaInput) (*DeleteSchemaOutput, error)

DeleteSchema API operation for Amazon CloudDirectory.

Deletes a given schema. Schemas in a development and published state can only be deleted.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DeleteSchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteSchema

func (*CloudDirectory) DeleteSchemaRequest

func (c *CloudDirectory) DeleteSchemaRequest(input *DeleteSchemaInput) (req *request.Request, output *DeleteSchemaOutput)

DeleteSchemaRequest generates a "aws/request.Request" representing the client's request for the DeleteSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteSchema for more information on using the DeleteSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteSchemaRequest method.
req, resp := client.DeleteSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteSchema

func (*CloudDirectory) DeleteSchemaWithContext added in v1.8.0

func (c *CloudDirectory) DeleteSchemaWithContext(ctx aws.Context, input *DeleteSchemaInput, opts ...request.Option) (*DeleteSchemaOutput, error)

DeleteSchemaWithContext is the same as DeleteSchema with the addition of the ability to pass a context and additional request options.

See DeleteSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DeleteTypedLinkFacet added in v1.8.31

func (c *CloudDirectory) DeleteTypedLinkFacet(input *DeleteTypedLinkFacetInput) (*DeleteTypedLinkFacetOutput, error)

DeleteTypedLinkFacet API operation for Amazon CloudDirectory.

Deletes a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DeleteTypedLinkFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteTypedLinkFacet

func (*CloudDirectory) DeleteTypedLinkFacetRequest added in v1.8.31

func (c *CloudDirectory) DeleteTypedLinkFacetRequest(input *DeleteTypedLinkFacetInput) (req *request.Request, output *DeleteTypedLinkFacetOutput)

DeleteTypedLinkFacetRequest generates a "aws/request.Request" representing the client's request for the DeleteTypedLinkFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteTypedLinkFacet for more information on using the DeleteTypedLinkFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteTypedLinkFacetRequest method.
req, resp := client.DeleteTypedLinkFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DeleteTypedLinkFacet

func (*CloudDirectory) DeleteTypedLinkFacetWithContext added in v1.8.31

func (c *CloudDirectory) DeleteTypedLinkFacetWithContext(ctx aws.Context, input *DeleteTypedLinkFacetInput, opts ...request.Option) (*DeleteTypedLinkFacetOutput, error)

DeleteTypedLinkFacetWithContext is the same as DeleteTypedLinkFacet with the addition of the ability to pass a context and additional request options.

See DeleteTypedLinkFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DetachFromIndex

func (c *CloudDirectory) DetachFromIndex(input *DetachFromIndexInput) (*DetachFromIndexOutput, error)

DetachFromIndex API operation for Amazon CloudDirectory.

Detaches the specified object from the specified index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DetachFromIndex for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeObjectAlreadyDetachedException "ObjectAlreadyDetachedException" Indicates that the object is not attached to the index.

  • ErrCodeNotIndexException "NotIndexException" Indicates that the requested operation can only operate on index objects.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachFromIndex

func (*CloudDirectory) DetachFromIndexRequest

func (c *CloudDirectory) DetachFromIndexRequest(input *DetachFromIndexInput) (req *request.Request, output *DetachFromIndexOutput)

DetachFromIndexRequest generates a "aws/request.Request" representing the client's request for the DetachFromIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachFromIndex for more information on using the DetachFromIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachFromIndexRequest method.
req, resp := client.DetachFromIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachFromIndex

func (*CloudDirectory) DetachFromIndexWithContext added in v1.8.0

func (c *CloudDirectory) DetachFromIndexWithContext(ctx aws.Context, input *DetachFromIndexInput, opts ...request.Option) (*DetachFromIndexOutput, error)

DetachFromIndexWithContext is the same as DetachFromIndex with the addition of the ability to pass a context and additional request options.

See DetachFromIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DetachObject

func (c *CloudDirectory) DetachObject(input *DetachObjectInput) (*DetachObjectOutput, error)

DetachObject API operation for Amazon CloudDirectory.

Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DetachObject for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachObject

func (*CloudDirectory) DetachObjectRequest

func (c *CloudDirectory) DetachObjectRequest(input *DetachObjectInput) (req *request.Request, output *DetachObjectOutput)

DetachObjectRequest generates a "aws/request.Request" representing the client's request for the DetachObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachObject for more information on using the DetachObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachObjectRequest method.
req, resp := client.DetachObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachObject

func (*CloudDirectory) DetachObjectWithContext added in v1.8.0

func (c *CloudDirectory) DetachObjectWithContext(ctx aws.Context, input *DetachObjectInput, opts ...request.Option) (*DetachObjectOutput, error)

DetachObjectWithContext is the same as DetachObject with the addition of the ability to pass a context and additional request options.

See DetachObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DetachPolicy

func (c *CloudDirectory) DetachPolicy(input *DetachPolicyInput) (*DetachPolicyOutput, error)

DetachPolicy API operation for Amazon CloudDirectory.

Detaches a policy from an object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DetachPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeNotPolicyException "NotPolicyException" Indicates that the requested operation can only operate on policy objects.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachPolicy

func (*CloudDirectory) DetachPolicyRequest

func (c *CloudDirectory) DetachPolicyRequest(input *DetachPolicyInput) (req *request.Request, output *DetachPolicyOutput)

DetachPolicyRequest generates a "aws/request.Request" representing the client's request for the DetachPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachPolicy for more information on using the DetachPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachPolicyRequest method.
req, resp := client.DetachPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachPolicy

func (*CloudDirectory) DetachPolicyWithContext added in v1.8.0

func (c *CloudDirectory) DetachPolicyWithContext(ctx aws.Context, input *DetachPolicyInput, opts ...request.Option) (*DetachPolicyOutput, error)

DetachPolicyWithContext is the same as DetachPolicy with the addition of the ability to pass a context and additional request options.

See DetachPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (c *CloudDirectory) DetachTypedLink(input *DetachTypedLinkInput) (*DetachTypedLinkOutput, error)

DetachTypedLink API operation for Amazon CloudDirectory.

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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DetachTypedLink for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachTypedLink

func (*CloudDirectory) DetachTypedLinkRequest added in v1.8.31

func (c *CloudDirectory) DetachTypedLinkRequest(input *DetachTypedLinkInput) (req *request.Request, output *DetachTypedLinkOutput)

DetachTypedLinkRequest generates a "aws/request.Request" representing the client's request for the DetachTypedLink operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DetachTypedLink for more information on using the DetachTypedLink API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DetachTypedLinkRequest method.
req, resp := client.DetachTypedLinkRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DetachTypedLink

func (*CloudDirectory) DetachTypedLinkWithContext added in v1.8.31

func (c *CloudDirectory) DetachTypedLinkWithContext(ctx aws.Context, input *DetachTypedLinkInput, opts ...request.Option) (*DetachTypedLinkOutput, error)

DetachTypedLinkWithContext is the same as DetachTypedLink with the addition of the ability to pass a context and additional request options.

See DetachTypedLink for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) DisableDirectory

func (c *CloudDirectory) DisableDirectory(input *DisableDirectoryInput) (*DisableDirectoryOutput, error)

DisableDirectory API operation for Amazon CloudDirectory.

Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation DisableDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DisableDirectory

func (*CloudDirectory) DisableDirectoryRequest

func (c *CloudDirectory) DisableDirectoryRequest(input *DisableDirectoryInput) (req *request.Request, output *DisableDirectoryOutput)

DisableDirectoryRequest generates a "aws/request.Request" representing the client's request for the DisableDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisableDirectory for more information on using the DisableDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisableDirectoryRequest method.
req, resp := client.DisableDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/DisableDirectory

func (*CloudDirectory) DisableDirectoryWithContext added in v1.8.0

func (c *CloudDirectory) DisableDirectoryWithContext(ctx aws.Context, input *DisableDirectoryInput, opts ...request.Option) (*DisableDirectoryOutput, error)

DisableDirectoryWithContext is the same as DisableDirectory with the addition of the ability to pass a context and additional request options.

See DisableDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) EnableDirectory

func (c *CloudDirectory) EnableDirectory(input *EnableDirectoryInput) (*EnableDirectoryOutput, error)

EnableDirectory API operation for Amazon CloudDirectory.

Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation EnableDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/EnableDirectory

func (*CloudDirectory) EnableDirectoryRequest

func (c *CloudDirectory) EnableDirectoryRequest(input *EnableDirectoryInput) (req *request.Request, output *EnableDirectoryOutput)

EnableDirectoryRequest generates a "aws/request.Request" representing the client's request for the EnableDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See EnableDirectory for more information on using the EnableDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the EnableDirectoryRequest method.
req, resp := client.EnableDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/EnableDirectory

func (*CloudDirectory) EnableDirectoryWithContext added in v1.8.0

func (c *CloudDirectory) EnableDirectoryWithContext(ctx aws.Context, input *EnableDirectoryInput, opts ...request.Option) (*EnableDirectoryOutput, error)

EnableDirectoryWithContext is the same as EnableDirectory with the addition of the ability to pass a context and additional request options.

See EnableDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetAppliedSchemaVersion added in v1.12.43

func (c *CloudDirectory) GetAppliedSchemaVersion(input *GetAppliedSchemaVersionInput) (*GetAppliedSchemaVersionOutput, error)

GetAppliedSchemaVersion API operation for Amazon CloudDirectory.

Returns current applied schema version ARN, including the minor version in use.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetAppliedSchemaVersion for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetAppliedSchemaVersion

func (*CloudDirectory) GetAppliedSchemaVersionRequest added in v1.12.43

func (c *CloudDirectory) GetAppliedSchemaVersionRequest(input *GetAppliedSchemaVersionInput) (req *request.Request, output *GetAppliedSchemaVersionOutput)

GetAppliedSchemaVersionRequest generates a "aws/request.Request" representing the client's request for the GetAppliedSchemaVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAppliedSchemaVersion for more information on using the GetAppliedSchemaVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAppliedSchemaVersionRequest method.
req, resp := client.GetAppliedSchemaVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetAppliedSchemaVersion

func (*CloudDirectory) GetAppliedSchemaVersionWithContext added in v1.12.43

func (c *CloudDirectory) GetAppliedSchemaVersionWithContext(ctx aws.Context, input *GetAppliedSchemaVersionInput, opts ...request.Option) (*GetAppliedSchemaVersionOutput, error)

GetAppliedSchemaVersionWithContext is the same as GetAppliedSchemaVersion with the addition of the ability to pass a context and additional request options.

See GetAppliedSchemaVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetDirectory

func (c *CloudDirectory) GetDirectory(input *GetDirectoryInput) (*GetDirectoryOutput, error)

GetDirectory API operation for Amazon CloudDirectory.

Retrieves metadata about a directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetDirectory for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetDirectory

func (*CloudDirectory) GetDirectoryRequest

func (c *CloudDirectory) GetDirectoryRequest(input *GetDirectoryInput) (req *request.Request, output *GetDirectoryOutput)

GetDirectoryRequest generates a "aws/request.Request" representing the client's request for the GetDirectory operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetDirectory for more information on using the GetDirectory API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetDirectoryRequest method.
req, resp := client.GetDirectoryRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetDirectory

func (*CloudDirectory) GetDirectoryWithContext added in v1.8.0

func (c *CloudDirectory) GetDirectoryWithContext(ctx aws.Context, input *GetDirectoryInput, opts ...request.Option) (*GetDirectoryOutput, error)

GetDirectoryWithContext is the same as GetDirectory with the addition of the ability to pass a context and additional request options.

See GetDirectory for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetFacet

func (c *CloudDirectory) GetFacet(input *GetFacetInput) (*GetFacetOutput, error)

GetFacet API operation for Amazon CloudDirectory.

Gets details of the Facet, such as facet name, attributes, Rules, or ObjectType. You can call this on all kinds of schema facets -- published, development, or applied.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetFacet

func (*CloudDirectory) GetFacetRequest

func (c *CloudDirectory) GetFacetRequest(input *GetFacetInput) (req *request.Request, output *GetFacetOutput)

GetFacetRequest generates a "aws/request.Request" representing the client's request for the GetFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetFacet for more information on using the GetFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetFacetRequest method.
req, resp := client.GetFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetFacet

func (*CloudDirectory) GetFacetWithContext added in v1.8.0

func (c *CloudDirectory) GetFacetWithContext(ctx aws.Context, input *GetFacetInput, opts ...request.Option) (*GetFacetOutput, error)

GetFacetWithContext is the same as GetFacet with the addition of the ability to pass a context and additional request options.

See GetFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetLinkAttributes added in v1.14.4

func (c *CloudDirectory) GetLinkAttributes(input *GetLinkAttributesInput) (*GetLinkAttributesOutput, error)

GetLinkAttributes API operation for Amazon CloudDirectory.

Retrieves attributes that are associated with a typed link.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetLinkAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetLinkAttributes

func (*CloudDirectory) GetLinkAttributesRequest added in v1.14.4

func (c *CloudDirectory) GetLinkAttributesRequest(input *GetLinkAttributesInput) (req *request.Request, output *GetLinkAttributesOutput)

GetLinkAttributesRequest generates a "aws/request.Request" representing the client's request for the GetLinkAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLinkAttributes for more information on using the GetLinkAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLinkAttributesRequest method.
req, resp := client.GetLinkAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetLinkAttributes

func (*CloudDirectory) GetLinkAttributesWithContext added in v1.14.4

func (c *CloudDirectory) GetLinkAttributesWithContext(ctx aws.Context, input *GetLinkAttributesInput, opts ...request.Option) (*GetLinkAttributesOutput, error)

GetLinkAttributesWithContext is the same as GetLinkAttributes with the addition of the ability to pass a context and additional request options.

See GetLinkAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetObjectAttributes added in v1.13.31

func (c *CloudDirectory) GetObjectAttributes(input *GetObjectAttributesInput) (*GetObjectAttributesOutput, error)

GetObjectAttributes API operation for Amazon CloudDirectory.

Retrieves attributes within a facet that are associated with an object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetObjectAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetObjectAttributes

func (*CloudDirectory) GetObjectAttributesRequest added in v1.13.31

func (c *CloudDirectory) GetObjectAttributesRequest(input *GetObjectAttributesInput) (req *request.Request, output *GetObjectAttributesOutput)

GetObjectAttributesRequest generates a "aws/request.Request" representing the client's request for the GetObjectAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetObjectAttributes for more information on using the GetObjectAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetObjectAttributesRequest method.
req, resp := client.GetObjectAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetObjectAttributes

func (*CloudDirectory) GetObjectAttributesWithContext added in v1.13.31

func (c *CloudDirectory) GetObjectAttributesWithContext(ctx aws.Context, input *GetObjectAttributesInput, opts ...request.Option) (*GetObjectAttributesOutput, error)

GetObjectAttributesWithContext is the same as GetObjectAttributes with the addition of the ability to pass a context and additional request options.

See GetObjectAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetObjectInformation

func (c *CloudDirectory) GetObjectInformation(input *GetObjectInformationInput) (*GetObjectInformationOutput, error)

GetObjectInformation API operation for Amazon CloudDirectory.

Retrieves metadata about an object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetObjectInformation for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetObjectInformation

func (*CloudDirectory) GetObjectInformationRequest

func (c *CloudDirectory) GetObjectInformationRequest(input *GetObjectInformationInput) (req *request.Request, output *GetObjectInformationOutput)

GetObjectInformationRequest generates a "aws/request.Request" representing the client's request for the GetObjectInformation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetObjectInformation for more information on using the GetObjectInformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetObjectInformationRequest method.
req, resp := client.GetObjectInformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetObjectInformation

func (*CloudDirectory) GetObjectInformationWithContext added in v1.8.0

func (c *CloudDirectory) GetObjectInformationWithContext(ctx aws.Context, input *GetObjectInformationInput, opts ...request.Option) (*GetObjectInformationOutput, error)

GetObjectInformationWithContext is the same as GetObjectInformation with the addition of the ability to pass a context and additional request options.

See GetObjectInformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetSchemaAsJson

func (c *CloudDirectory) GetSchemaAsJson(input *GetSchemaAsJsonInput) (*GetSchemaAsJsonOutput, error)

GetSchemaAsJson API operation for Amazon CloudDirectory.

Retrieves a JSON representation of the schema. See JSON Schema Format (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) for more information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetSchemaAsJson for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetSchemaAsJson

func (*CloudDirectory) GetSchemaAsJsonRequest

func (c *CloudDirectory) GetSchemaAsJsonRequest(input *GetSchemaAsJsonInput) (req *request.Request, output *GetSchemaAsJsonOutput)

GetSchemaAsJsonRequest generates a "aws/request.Request" representing the client's request for the GetSchemaAsJson operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSchemaAsJson for more information on using the GetSchemaAsJson API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSchemaAsJsonRequest method.
req, resp := client.GetSchemaAsJsonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetSchemaAsJson

func (*CloudDirectory) GetSchemaAsJsonWithContext added in v1.8.0

func (c *CloudDirectory) GetSchemaAsJsonWithContext(ctx aws.Context, input *GetSchemaAsJsonInput, opts ...request.Option) (*GetSchemaAsJsonOutput, error)

GetSchemaAsJsonWithContext is the same as GetSchemaAsJson with the addition of the ability to pass a context and additional request options.

See GetSchemaAsJson for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) GetTypedLinkFacetInformation added in v1.8.31

GetTypedLinkFacetInformation API operation for Amazon CloudDirectory.

Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation GetTypedLinkFacetInformation for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetTypedLinkFacetInformation

func (*CloudDirectory) GetTypedLinkFacetInformationRequest added in v1.8.31

func (c *CloudDirectory) GetTypedLinkFacetInformationRequest(input *GetTypedLinkFacetInformationInput) (req *request.Request, output *GetTypedLinkFacetInformationOutput)

GetTypedLinkFacetInformationRequest generates a "aws/request.Request" representing the client's request for the GetTypedLinkFacetInformation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetTypedLinkFacetInformation for more information on using the GetTypedLinkFacetInformation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetTypedLinkFacetInformationRequest method.
req, resp := client.GetTypedLinkFacetInformationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/GetTypedLinkFacetInformation

func (*CloudDirectory) GetTypedLinkFacetInformationWithContext added in v1.8.31

func (c *CloudDirectory) GetTypedLinkFacetInformationWithContext(ctx aws.Context, input *GetTypedLinkFacetInformationInput, opts ...request.Option) (*GetTypedLinkFacetInformationOutput, error)

GetTypedLinkFacetInformationWithContext is the same as GetTypedLinkFacetInformation with the addition of the ability to pass a context and additional request options.

See GetTypedLinkFacetInformation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListAppliedSchemaArns

func (c *CloudDirectory) ListAppliedSchemaArns(input *ListAppliedSchemaArnsInput) (*ListAppliedSchemaArnsOutput, error)

ListAppliedSchemaArns API operation for Amazon CloudDirectory.

Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListAppliedSchemaArns for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListAppliedSchemaArns

func (*CloudDirectory) ListAppliedSchemaArnsPages

func (c *CloudDirectory) ListAppliedSchemaArnsPages(input *ListAppliedSchemaArnsInput, fn func(*ListAppliedSchemaArnsOutput, bool) bool) error

ListAppliedSchemaArnsPages iterates over the pages of a ListAppliedSchemaArns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAppliedSchemaArns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAppliedSchemaArns operation.
pageNum := 0
err := client.ListAppliedSchemaArnsPages(params,
    func(page *clouddirectory.ListAppliedSchemaArnsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListAppliedSchemaArnsPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListAppliedSchemaArnsPagesWithContext(ctx aws.Context, input *ListAppliedSchemaArnsInput, fn func(*ListAppliedSchemaArnsOutput, bool) bool, opts ...request.Option) error

ListAppliedSchemaArnsPagesWithContext same as ListAppliedSchemaArnsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListAppliedSchemaArnsRequest

func (c *CloudDirectory) ListAppliedSchemaArnsRequest(input *ListAppliedSchemaArnsInput) (req *request.Request, output *ListAppliedSchemaArnsOutput)

ListAppliedSchemaArnsRequest generates a "aws/request.Request" representing the client's request for the ListAppliedSchemaArns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAppliedSchemaArns for more information on using the ListAppliedSchemaArns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAppliedSchemaArnsRequest method.
req, resp := client.ListAppliedSchemaArnsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListAppliedSchemaArns

func (*CloudDirectory) ListAppliedSchemaArnsWithContext added in v1.8.0

func (c *CloudDirectory) ListAppliedSchemaArnsWithContext(ctx aws.Context, input *ListAppliedSchemaArnsInput, opts ...request.Option) (*ListAppliedSchemaArnsOutput, error)

ListAppliedSchemaArnsWithContext is the same as ListAppliedSchemaArns with the addition of the ability to pass a context and additional request options.

See ListAppliedSchemaArns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListAttachedIndices

func (c *CloudDirectory) ListAttachedIndices(input *ListAttachedIndicesInput) (*ListAttachedIndicesOutput, error)

ListAttachedIndices API operation for Amazon CloudDirectory.

Lists indices attached to the specified object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListAttachedIndices for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListAttachedIndices

func (*CloudDirectory) ListAttachedIndicesPages

func (c *CloudDirectory) ListAttachedIndicesPages(input *ListAttachedIndicesInput, fn func(*ListAttachedIndicesOutput, bool) bool) error

ListAttachedIndicesPages iterates over the pages of a ListAttachedIndices operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAttachedIndices method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAttachedIndices operation.
pageNum := 0
err := client.ListAttachedIndicesPages(params,
    func(page *clouddirectory.ListAttachedIndicesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListAttachedIndicesPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListAttachedIndicesPagesWithContext(ctx aws.Context, input *ListAttachedIndicesInput, fn func(*ListAttachedIndicesOutput, bool) bool, opts ...request.Option) error

ListAttachedIndicesPagesWithContext same as ListAttachedIndicesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListAttachedIndicesRequest

func (c *CloudDirectory) ListAttachedIndicesRequest(input *ListAttachedIndicesInput) (req *request.Request, output *ListAttachedIndicesOutput)

ListAttachedIndicesRequest generates a "aws/request.Request" representing the client's request for the ListAttachedIndices operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAttachedIndices for more information on using the ListAttachedIndices API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAttachedIndicesRequest method.
req, resp := client.ListAttachedIndicesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListAttachedIndices

func (*CloudDirectory) ListAttachedIndicesWithContext added in v1.8.0

func (c *CloudDirectory) ListAttachedIndicesWithContext(ctx aws.Context, input *ListAttachedIndicesInput, opts ...request.Option) (*ListAttachedIndicesOutput, error)

ListAttachedIndicesWithContext is the same as ListAttachedIndices with the addition of the ability to pass a context and additional request options.

See ListAttachedIndices for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListDevelopmentSchemaArns

ListDevelopmentSchemaArns API operation for Amazon CloudDirectory.

Retrieves each Amazon Resource Name (ARN) of schemas in the development state.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListDevelopmentSchemaArns for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListDevelopmentSchemaArns

func (*CloudDirectory) ListDevelopmentSchemaArnsPages

func (c *CloudDirectory) ListDevelopmentSchemaArnsPages(input *ListDevelopmentSchemaArnsInput, fn func(*ListDevelopmentSchemaArnsOutput, bool) bool) error

ListDevelopmentSchemaArnsPages iterates over the pages of a ListDevelopmentSchemaArns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDevelopmentSchemaArns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDevelopmentSchemaArns operation.
pageNum := 0
err := client.ListDevelopmentSchemaArnsPages(params,
    func(page *clouddirectory.ListDevelopmentSchemaArnsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListDevelopmentSchemaArnsPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListDevelopmentSchemaArnsPagesWithContext(ctx aws.Context, input *ListDevelopmentSchemaArnsInput, fn func(*ListDevelopmentSchemaArnsOutput, bool) bool, opts ...request.Option) error

ListDevelopmentSchemaArnsPagesWithContext same as ListDevelopmentSchemaArnsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListDevelopmentSchemaArnsRequest

func (c *CloudDirectory) ListDevelopmentSchemaArnsRequest(input *ListDevelopmentSchemaArnsInput) (req *request.Request, output *ListDevelopmentSchemaArnsOutput)

ListDevelopmentSchemaArnsRequest generates a "aws/request.Request" representing the client's request for the ListDevelopmentSchemaArns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDevelopmentSchemaArns for more information on using the ListDevelopmentSchemaArns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDevelopmentSchemaArnsRequest method.
req, resp := client.ListDevelopmentSchemaArnsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListDevelopmentSchemaArns

func (*CloudDirectory) ListDevelopmentSchemaArnsWithContext added in v1.8.0

func (c *CloudDirectory) ListDevelopmentSchemaArnsWithContext(ctx aws.Context, input *ListDevelopmentSchemaArnsInput, opts ...request.Option) (*ListDevelopmentSchemaArnsOutput, error)

ListDevelopmentSchemaArnsWithContext is the same as ListDevelopmentSchemaArns with the addition of the ability to pass a context and additional request options.

See ListDevelopmentSchemaArns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListDirectories

func (c *CloudDirectory) ListDirectories(input *ListDirectoriesInput) (*ListDirectoriesOutput, error)

ListDirectories API operation for Amazon CloudDirectory.

Lists directories created within an account.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListDirectories for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListDirectories

func (*CloudDirectory) ListDirectoriesPages

func (c *CloudDirectory) ListDirectoriesPages(input *ListDirectoriesInput, fn func(*ListDirectoriesOutput, bool) bool) error

ListDirectoriesPages iterates over the pages of a ListDirectories operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListDirectories method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListDirectories operation.
pageNum := 0
err := client.ListDirectoriesPages(params,
    func(page *clouddirectory.ListDirectoriesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListDirectoriesPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListDirectoriesPagesWithContext(ctx aws.Context, input *ListDirectoriesInput, fn func(*ListDirectoriesOutput, bool) bool, opts ...request.Option) error

ListDirectoriesPagesWithContext same as ListDirectoriesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListDirectoriesRequest

func (c *CloudDirectory) ListDirectoriesRequest(input *ListDirectoriesInput) (req *request.Request, output *ListDirectoriesOutput)

ListDirectoriesRequest generates a "aws/request.Request" representing the client's request for the ListDirectories operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListDirectories for more information on using the ListDirectories API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListDirectoriesRequest method.
req, resp := client.ListDirectoriesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListDirectories

func (*CloudDirectory) ListDirectoriesWithContext added in v1.8.0

func (c *CloudDirectory) ListDirectoriesWithContext(ctx aws.Context, input *ListDirectoriesInput, opts ...request.Option) (*ListDirectoriesOutput, error)

ListDirectoriesWithContext is the same as ListDirectories with the addition of the ability to pass a context and additional request options.

See ListDirectories for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListFacetAttributes

func (c *CloudDirectory) ListFacetAttributes(input *ListFacetAttributesInput) (*ListFacetAttributesOutput, error)

ListFacetAttributes API operation for Amazon CloudDirectory.

Retrieves attributes attached to the facet.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListFacetAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListFacetAttributes

func (*CloudDirectory) ListFacetAttributesPages

func (c *CloudDirectory) ListFacetAttributesPages(input *ListFacetAttributesInput, fn func(*ListFacetAttributesOutput, bool) bool) error

ListFacetAttributesPages iterates over the pages of a ListFacetAttributes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFacetAttributes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFacetAttributes operation.
pageNum := 0
err := client.ListFacetAttributesPages(params,
    func(page *clouddirectory.ListFacetAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListFacetAttributesPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListFacetAttributesPagesWithContext(ctx aws.Context, input *ListFacetAttributesInput, fn func(*ListFacetAttributesOutput, bool) bool, opts ...request.Option) error

ListFacetAttributesPagesWithContext same as ListFacetAttributesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListFacetAttributesRequest

func (c *CloudDirectory) ListFacetAttributesRequest(input *ListFacetAttributesInput) (req *request.Request, output *ListFacetAttributesOutput)

ListFacetAttributesRequest generates a "aws/request.Request" representing the client's request for the ListFacetAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFacetAttributes for more information on using the ListFacetAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFacetAttributesRequest method.
req, resp := client.ListFacetAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListFacetAttributes

func (*CloudDirectory) ListFacetAttributesWithContext added in v1.8.0

func (c *CloudDirectory) ListFacetAttributesWithContext(ctx aws.Context, input *ListFacetAttributesInput, opts ...request.Option) (*ListFacetAttributesOutput, error)

ListFacetAttributesWithContext is the same as ListFacetAttributes with the addition of the ability to pass a context and additional request options.

See ListFacetAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListFacetNames

func (c *CloudDirectory) ListFacetNames(input *ListFacetNamesInput) (*ListFacetNamesOutput, error)

ListFacetNames API operation for Amazon CloudDirectory.

Retrieves the names of facets that exist in a schema.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListFacetNames for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListFacetNames

func (*CloudDirectory) ListFacetNamesPages

func (c *CloudDirectory) ListFacetNamesPages(input *ListFacetNamesInput, fn func(*ListFacetNamesOutput, bool) bool) error

ListFacetNamesPages iterates over the pages of a ListFacetNames operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFacetNames method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFacetNames operation.
pageNum := 0
err := client.ListFacetNamesPages(params,
    func(page *clouddirectory.ListFacetNamesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListFacetNamesPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListFacetNamesPagesWithContext(ctx aws.Context, input *ListFacetNamesInput, fn func(*ListFacetNamesOutput, bool) bool, opts ...request.Option) error

ListFacetNamesPagesWithContext same as ListFacetNamesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListFacetNamesRequest

func (c *CloudDirectory) ListFacetNamesRequest(input *ListFacetNamesInput) (req *request.Request, output *ListFacetNamesOutput)

ListFacetNamesRequest generates a "aws/request.Request" representing the client's request for the ListFacetNames operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFacetNames for more information on using the ListFacetNames API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFacetNamesRequest method.
req, resp := client.ListFacetNamesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListFacetNames

func (*CloudDirectory) ListFacetNamesWithContext added in v1.8.0

func (c *CloudDirectory) ListFacetNamesWithContext(ctx aws.Context, input *ListFacetNamesInput, opts ...request.Option) (*ListFacetNamesOutput, error)

ListFacetNamesWithContext is the same as ListFacetNames with the addition of the ability to pass a context and additional request options.

See ListFacetNames for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (c *CloudDirectory) ListIncomingTypedLinks(input *ListIncomingTypedLinksInput) (*ListIncomingTypedLinksOutput, error)

ListIncomingTypedLinks API operation for Amazon CloudDirectory.

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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListIncomingTypedLinks for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListIncomingTypedLinks

func (*CloudDirectory) ListIncomingTypedLinksRequest added in v1.8.31

func (c *CloudDirectory) ListIncomingTypedLinksRequest(input *ListIncomingTypedLinksInput) (req *request.Request, output *ListIncomingTypedLinksOutput)

ListIncomingTypedLinksRequest generates a "aws/request.Request" representing the client's request for the ListIncomingTypedLinks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIncomingTypedLinks for more information on using the ListIncomingTypedLinks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIncomingTypedLinksRequest method.
req, resp := client.ListIncomingTypedLinksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListIncomingTypedLinks

func (*CloudDirectory) ListIncomingTypedLinksWithContext added in v1.8.31

func (c *CloudDirectory) ListIncomingTypedLinksWithContext(ctx aws.Context, input *ListIncomingTypedLinksInput, opts ...request.Option) (*ListIncomingTypedLinksOutput, error)

ListIncomingTypedLinksWithContext is the same as ListIncomingTypedLinks with the addition of the ability to pass a context and additional request options.

See ListIncomingTypedLinks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListIndex

func (c *CloudDirectory) ListIndex(input *ListIndexInput) (*ListIndexOutput, error)

ListIndex API operation for Amazon CloudDirectory.

Lists objects attached to the specified index.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListIndex for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

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

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeNotIndexException "NotIndexException" Indicates that the requested operation can only operate on index objects.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListIndex

func (*CloudDirectory) ListIndexPages

func (c *CloudDirectory) ListIndexPages(input *ListIndexInput, fn func(*ListIndexOutput, bool) bool) error

ListIndexPages iterates over the pages of a ListIndex operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListIndex method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListIndex operation.
pageNum := 0
err := client.ListIndexPages(params,
    func(page *clouddirectory.ListIndexOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListIndexPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListIndexPagesWithContext(ctx aws.Context, input *ListIndexInput, fn func(*ListIndexOutput, bool) bool, opts ...request.Option) error

ListIndexPagesWithContext same as ListIndexPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListIndexRequest

func (c *CloudDirectory) ListIndexRequest(input *ListIndexInput) (req *request.Request, output *ListIndexOutput)

ListIndexRequest generates a "aws/request.Request" representing the client's request for the ListIndex operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListIndex for more information on using the ListIndex API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListIndexRequest method.
req, resp := client.ListIndexRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListIndex

func (*CloudDirectory) ListIndexWithContext added in v1.8.0

func (c *CloudDirectory) ListIndexWithContext(ctx aws.Context, input *ListIndexInput, opts ...request.Option) (*ListIndexOutput, error)

ListIndexWithContext is the same as ListIndex with the addition of the ability to pass a context and additional request options.

See ListIndex for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListManagedSchemaArns added in v1.14.12

func (c *CloudDirectory) ListManagedSchemaArns(input *ListManagedSchemaArnsInput) (*ListManagedSchemaArnsOutput, error)

ListManagedSchemaArns API operation for Amazon CloudDirectory.

Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListManagedSchemaArns for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListManagedSchemaArns

func (*CloudDirectory) ListManagedSchemaArnsPages added in v1.14.12

func (c *CloudDirectory) ListManagedSchemaArnsPages(input *ListManagedSchemaArnsInput, fn func(*ListManagedSchemaArnsOutput, bool) bool) error

ListManagedSchemaArnsPages iterates over the pages of a ListManagedSchemaArns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListManagedSchemaArns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListManagedSchemaArns operation.
pageNum := 0
err := client.ListManagedSchemaArnsPages(params,
    func(page *clouddirectory.ListManagedSchemaArnsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListManagedSchemaArnsPagesWithContext added in v1.14.12

func (c *CloudDirectory) ListManagedSchemaArnsPagesWithContext(ctx aws.Context, input *ListManagedSchemaArnsInput, fn func(*ListManagedSchemaArnsOutput, bool) bool, opts ...request.Option) error

ListManagedSchemaArnsPagesWithContext same as ListManagedSchemaArnsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListManagedSchemaArnsRequest added in v1.14.12

func (c *CloudDirectory) ListManagedSchemaArnsRequest(input *ListManagedSchemaArnsInput) (req *request.Request, output *ListManagedSchemaArnsOutput)

ListManagedSchemaArnsRequest generates a "aws/request.Request" representing the client's request for the ListManagedSchemaArns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListManagedSchemaArns for more information on using the ListManagedSchemaArns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListManagedSchemaArnsRequest method.
req, resp := client.ListManagedSchemaArnsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListManagedSchemaArns

func (*CloudDirectory) ListManagedSchemaArnsWithContext added in v1.14.12

func (c *CloudDirectory) ListManagedSchemaArnsWithContext(ctx aws.Context, input *ListManagedSchemaArnsInput, opts ...request.Option) (*ListManagedSchemaArnsOutput, error)

ListManagedSchemaArnsWithContext is the same as ListManagedSchemaArns with the addition of the ability to pass a context and additional request options.

See ListManagedSchemaArns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectAttributes

func (c *CloudDirectory) ListObjectAttributes(input *ListObjectAttributesInput) (*ListObjectAttributesOutput, error)

ListObjectAttributes API operation for Amazon CloudDirectory.

Lists all attributes that are associated with an object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListObjectAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectAttributes

func (*CloudDirectory) ListObjectAttributesPages

func (c *CloudDirectory) ListObjectAttributesPages(input *ListObjectAttributesInput, fn func(*ListObjectAttributesOutput, bool) bool) error

ListObjectAttributesPages iterates over the pages of a ListObjectAttributes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListObjectAttributes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListObjectAttributes operation.
pageNum := 0
err := client.ListObjectAttributesPages(params,
    func(page *clouddirectory.ListObjectAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListObjectAttributesPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectAttributesPagesWithContext(ctx aws.Context, input *ListObjectAttributesInput, fn func(*ListObjectAttributesOutput, bool) bool, opts ...request.Option) error

ListObjectAttributesPagesWithContext same as ListObjectAttributesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectAttributesRequest

func (c *CloudDirectory) ListObjectAttributesRequest(input *ListObjectAttributesInput) (req *request.Request, output *ListObjectAttributesOutput)

ListObjectAttributesRequest generates a "aws/request.Request" representing the client's request for the ListObjectAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListObjectAttributes for more information on using the ListObjectAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListObjectAttributesRequest method.
req, resp := client.ListObjectAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectAttributes

func (*CloudDirectory) ListObjectAttributesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectAttributesWithContext(ctx aws.Context, input *ListObjectAttributesInput, opts ...request.Option) (*ListObjectAttributesOutput, error)

ListObjectAttributesWithContext is the same as ListObjectAttributes with the addition of the ability to pass a context and additional request options.

See ListObjectAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectChildren

func (c *CloudDirectory) ListObjectChildren(input *ListObjectChildrenInput) (*ListObjectChildrenOutput, error)

ListObjectChildren API operation for Amazon CloudDirectory.

Returns a paginated list of child objects that are associated with a given object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListObjectChildren for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectChildren

func (*CloudDirectory) ListObjectChildrenPages

func (c *CloudDirectory) ListObjectChildrenPages(input *ListObjectChildrenInput, fn func(*ListObjectChildrenOutput, bool) bool) error

ListObjectChildrenPages iterates over the pages of a ListObjectChildren operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListObjectChildren method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListObjectChildren operation.
pageNum := 0
err := client.ListObjectChildrenPages(params,
    func(page *clouddirectory.ListObjectChildrenOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListObjectChildrenPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectChildrenPagesWithContext(ctx aws.Context, input *ListObjectChildrenInput, fn func(*ListObjectChildrenOutput, bool) bool, opts ...request.Option) error

ListObjectChildrenPagesWithContext same as ListObjectChildrenPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectChildrenRequest

func (c *CloudDirectory) ListObjectChildrenRequest(input *ListObjectChildrenInput) (req *request.Request, output *ListObjectChildrenOutput)

ListObjectChildrenRequest generates a "aws/request.Request" representing the client's request for the ListObjectChildren operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListObjectChildren for more information on using the ListObjectChildren API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListObjectChildrenRequest method.
req, resp := client.ListObjectChildrenRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectChildren

func (*CloudDirectory) ListObjectChildrenWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectChildrenWithContext(ctx aws.Context, input *ListObjectChildrenInput, opts ...request.Option) (*ListObjectChildrenOutput, error)

ListObjectChildrenWithContext is the same as ListObjectChildren with the addition of the ability to pass a context and additional request options.

See ListObjectChildren for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectParentPaths added in v1.7.7

func (c *CloudDirectory) ListObjectParentPaths(input *ListObjectParentPathsInput) (*ListObjectParentPathsOutput, error)

ListObjectParentPaths API operation for Amazon CloudDirectory.

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).

Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListObjectParentPaths for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectParentPaths

func (*CloudDirectory) ListObjectParentPathsPages added in v1.7.7

func (c *CloudDirectory) ListObjectParentPathsPages(input *ListObjectParentPathsInput, fn func(*ListObjectParentPathsOutput, bool) bool) error

ListObjectParentPathsPages iterates over the pages of a ListObjectParentPaths operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListObjectParentPaths method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListObjectParentPaths operation.
pageNum := 0
err := client.ListObjectParentPathsPages(params,
    func(page *clouddirectory.ListObjectParentPathsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListObjectParentPathsPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectParentPathsPagesWithContext(ctx aws.Context, input *ListObjectParentPathsInput, fn func(*ListObjectParentPathsOutput, bool) bool, opts ...request.Option) error

ListObjectParentPathsPagesWithContext same as ListObjectParentPathsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectParentPathsRequest added in v1.7.7

func (c *CloudDirectory) ListObjectParentPathsRequest(input *ListObjectParentPathsInput) (req *request.Request, output *ListObjectParentPathsOutput)

ListObjectParentPathsRequest generates a "aws/request.Request" representing the client's request for the ListObjectParentPaths operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListObjectParentPaths for more information on using the ListObjectParentPaths API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListObjectParentPathsRequest method.
req, resp := client.ListObjectParentPathsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectParentPaths

func (*CloudDirectory) ListObjectParentPathsWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectParentPathsWithContext(ctx aws.Context, input *ListObjectParentPathsInput, opts ...request.Option) (*ListObjectParentPathsOutput, error)

ListObjectParentPathsWithContext is the same as ListObjectParentPaths with the addition of the ability to pass a context and additional request options.

See ListObjectParentPaths for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectParents

func (c *CloudDirectory) ListObjectParents(input *ListObjectParentsInput) (*ListObjectParentsOutput, error)

ListObjectParents API operation for Amazon CloudDirectory.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListObjectParents for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

  • ErrCodeCannotListParentOfRootException "CannotListParentOfRootException" Cannot list the parents of a Directory root.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectParents

func (*CloudDirectory) ListObjectParentsPages

func (c *CloudDirectory) ListObjectParentsPages(input *ListObjectParentsInput, fn func(*ListObjectParentsOutput, bool) bool) error

ListObjectParentsPages iterates over the pages of a ListObjectParents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListObjectParents method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListObjectParents operation.
pageNum := 0
err := client.ListObjectParentsPages(params,
    func(page *clouddirectory.ListObjectParentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListObjectParentsPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectParentsPagesWithContext(ctx aws.Context, input *ListObjectParentsInput, fn func(*ListObjectParentsOutput, bool) bool, opts ...request.Option) error

ListObjectParentsPagesWithContext same as ListObjectParentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectParentsRequest

func (c *CloudDirectory) ListObjectParentsRequest(input *ListObjectParentsInput) (req *request.Request, output *ListObjectParentsOutput)

ListObjectParentsRequest generates a "aws/request.Request" representing the client's request for the ListObjectParents operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListObjectParents for more information on using the ListObjectParents API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListObjectParentsRequest method.
req, resp := client.ListObjectParentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectParents

func (*CloudDirectory) ListObjectParentsWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectParentsWithContext(ctx aws.Context, input *ListObjectParentsInput, opts ...request.Option) (*ListObjectParentsOutput, error)

ListObjectParentsWithContext is the same as ListObjectParents with the addition of the ability to pass a context and additional request options.

See ListObjectParents for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectPolicies

func (c *CloudDirectory) ListObjectPolicies(input *ListObjectPoliciesInput) (*ListObjectPoliciesOutput, error)

ListObjectPolicies API operation for Amazon CloudDirectory.

Returns policies attached to an object in pagination fashion.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListObjectPolicies for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectPolicies

func (*CloudDirectory) ListObjectPoliciesPages

func (c *CloudDirectory) ListObjectPoliciesPages(input *ListObjectPoliciesInput, fn func(*ListObjectPoliciesOutput, bool) bool) error

ListObjectPoliciesPages iterates over the pages of a ListObjectPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListObjectPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListObjectPolicies operation.
pageNum := 0
err := client.ListObjectPoliciesPages(params,
    func(page *clouddirectory.ListObjectPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListObjectPoliciesPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectPoliciesPagesWithContext(ctx aws.Context, input *ListObjectPoliciesInput, fn func(*ListObjectPoliciesOutput, bool) bool, opts ...request.Option) error

ListObjectPoliciesPagesWithContext same as ListObjectPoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListObjectPoliciesRequest

func (c *CloudDirectory) ListObjectPoliciesRequest(input *ListObjectPoliciesInput) (req *request.Request, output *ListObjectPoliciesOutput)

ListObjectPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListObjectPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListObjectPolicies for more information on using the ListObjectPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListObjectPoliciesRequest method.
req, resp := client.ListObjectPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListObjectPolicies

func (*CloudDirectory) ListObjectPoliciesWithContext added in v1.8.0

func (c *CloudDirectory) ListObjectPoliciesWithContext(ctx aws.Context, input *ListObjectPoliciesInput, opts ...request.Option) (*ListObjectPoliciesOutput, error)

ListObjectPoliciesWithContext is the same as ListObjectPolicies with the addition of the ability to pass a context and additional request options.

See ListObjectPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (c *CloudDirectory) ListOutgoingTypedLinks(input *ListOutgoingTypedLinksInput) (*ListOutgoingTypedLinksOutput, error)

ListOutgoingTypedLinks API operation for Amazon CloudDirectory.

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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListOutgoingTypedLinks for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListOutgoingTypedLinks

func (*CloudDirectory) ListOutgoingTypedLinksRequest added in v1.8.31

func (c *CloudDirectory) ListOutgoingTypedLinksRequest(input *ListOutgoingTypedLinksInput) (req *request.Request, output *ListOutgoingTypedLinksOutput)

ListOutgoingTypedLinksRequest generates a "aws/request.Request" representing the client's request for the ListOutgoingTypedLinks operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListOutgoingTypedLinks for more information on using the ListOutgoingTypedLinks API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListOutgoingTypedLinksRequest method.
req, resp := client.ListOutgoingTypedLinksRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListOutgoingTypedLinks

func (*CloudDirectory) ListOutgoingTypedLinksWithContext added in v1.8.31

func (c *CloudDirectory) ListOutgoingTypedLinksWithContext(ctx aws.Context, input *ListOutgoingTypedLinksInput, opts ...request.Option) (*ListOutgoingTypedLinksOutput, error)

ListOutgoingTypedLinksWithContext is the same as ListOutgoingTypedLinks with the addition of the ability to pass a context and additional request options.

See ListOutgoingTypedLinks for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListPolicyAttachments

func (c *CloudDirectory) ListPolicyAttachments(input *ListPolicyAttachmentsInput) (*ListPolicyAttachmentsOutput, error)

ListPolicyAttachments API operation for Amazon CloudDirectory.

Returns all of the ObjectIdentifiers to which a given policy is attached.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListPolicyAttachments for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeNotPolicyException "NotPolicyException" Indicates that the requested operation can only operate on policy objects.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListPolicyAttachments

func (*CloudDirectory) ListPolicyAttachmentsPages

func (c *CloudDirectory) ListPolicyAttachmentsPages(input *ListPolicyAttachmentsInput, fn func(*ListPolicyAttachmentsOutput, bool) bool) error

ListPolicyAttachmentsPages iterates over the pages of a ListPolicyAttachments operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPolicyAttachments method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPolicyAttachments operation.
pageNum := 0
err := client.ListPolicyAttachmentsPages(params,
    func(page *clouddirectory.ListPolicyAttachmentsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListPolicyAttachmentsPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListPolicyAttachmentsPagesWithContext(ctx aws.Context, input *ListPolicyAttachmentsInput, fn func(*ListPolicyAttachmentsOutput, bool) bool, opts ...request.Option) error

ListPolicyAttachmentsPagesWithContext same as ListPolicyAttachmentsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListPolicyAttachmentsRequest

func (c *CloudDirectory) ListPolicyAttachmentsRequest(input *ListPolicyAttachmentsInput) (req *request.Request, output *ListPolicyAttachmentsOutput)

ListPolicyAttachmentsRequest generates a "aws/request.Request" representing the client's request for the ListPolicyAttachments operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPolicyAttachments for more information on using the ListPolicyAttachments API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPolicyAttachmentsRequest method.
req, resp := client.ListPolicyAttachmentsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListPolicyAttachments

func (*CloudDirectory) ListPolicyAttachmentsWithContext added in v1.8.0

func (c *CloudDirectory) ListPolicyAttachmentsWithContext(ctx aws.Context, input *ListPolicyAttachmentsInput, opts ...request.Option) (*ListPolicyAttachmentsOutput, error)

ListPolicyAttachmentsWithContext is the same as ListPolicyAttachments with the addition of the ability to pass a context and additional request options.

See ListPolicyAttachments for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListPublishedSchemaArns

func (c *CloudDirectory) ListPublishedSchemaArns(input *ListPublishedSchemaArnsInput) (*ListPublishedSchemaArnsOutput, error)

ListPublishedSchemaArns API operation for Amazon CloudDirectory.

Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListPublishedSchemaArns for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListPublishedSchemaArns

func (*CloudDirectory) ListPublishedSchemaArnsPages

func (c *CloudDirectory) ListPublishedSchemaArnsPages(input *ListPublishedSchemaArnsInput, fn func(*ListPublishedSchemaArnsOutput, bool) bool) error

ListPublishedSchemaArnsPages iterates over the pages of a ListPublishedSchemaArns operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListPublishedSchemaArns method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListPublishedSchemaArns operation.
pageNum := 0
err := client.ListPublishedSchemaArnsPages(params,
    func(page *clouddirectory.ListPublishedSchemaArnsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListPublishedSchemaArnsPagesWithContext added in v1.8.0

func (c *CloudDirectory) ListPublishedSchemaArnsPagesWithContext(ctx aws.Context, input *ListPublishedSchemaArnsInput, fn func(*ListPublishedSchemaArnsOutput, bool) bool, opts ...request.Option) error

ListPublishedSchemaArnsPagesWithContext same as ListPublishedSchemaArnsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListPublishedSchemaArnsRequest

func (c *CloudDirectory) ListPublishedSchemaArnsRequest(input *ListPublishedSchemaArnsInput) (req *request.Request, output *ListPublishedSchemaArnsOutput)

ListPublishedSchemaArnsRequest generates a "aws/request.Request" representing the client's request for the ListPublishedSchemaArns operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListPublishedSchemaArns for more information on using the ListPublishedSchemaArns API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListPublishedSchemaArnsRequest method.
req, resp := client.ListPublishedSchemaArnsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListPublishedSchemaArns

func (*CloudDirectory) ListPublishedSchemaArnsWithContext added in v1.8.0

func (c *CloudDirectory) ListPublishedSchemaArnsWithContext(ctx aws.Context, input *ListPublishedSchemaArnsInput, opts ...request.Option) (*ListPublishedSchemaArnsOutput, error)

ListPublishedSchemaArnsWithContext is the same as ListPublishedSchemaArns with the addition of the ability to pass a context and additional request options.

See ListPublishedSchemaArns for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListTagsForResource

func (c *CloudDirectory) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon CloudDirectory.

Returns tags for a resource. Tagging is currently supported only for directories with a limit of 50 tags per directory. All 50 tags are returned for a given directory with this API call.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidTaggingRequestException "InvalidTaggingRequestException" 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListTagsForResource

func (*CloudDirectory) ListTagsForResourcePages

func (c *CloudDirectory) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *clouddirectory.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListTagsForResourcePagesWithContext added in v1.8.0

func (c *CloudDirectory) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListTagsForResourceRequest

func (c *CloudDirectory) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListTagsForResource

func (*CloudDirectory) ListTagsForResourceWithContext added in v1.8.0

func (c *CloudDirectory) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListTypedLinkFacetAttributes added in v1.8.31

ListTypedLinkFacetAttributes API operation for Amazon CloudDirectory.

Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListTypedLinkFacetAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListTypedLinkFacetAttributes

func (*CloudDirectory) ListTypedLinkFacetAttributesPages added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetAttributesPages(input *ListTypedLinkFacetAttributesInput, fn func(*ListTypedLinkFacetAttributesOutput, bool) bool) error

ListTypedLinkFacetAttributesPages iterates over the pages of a ListTypedLinkFacetAttributes operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTypedLinkFacetAttributes method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTypedLinkFacetAttributes operation.
pageNum := 0
err := client.ListTypedLinkFacetAttributesPages(params,
    func(page *clouddirectory.ListTypedLinkFacetAttributesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListTypedLinkFacetAttributesPagesWithContext added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetAttributesPagesWithContext(ctx aws.Context, input *ListTypedLinkFacetAttributesInput, fn func(*ListTypedLinkFacetAttributesOutput, bool) bool, opts ...request.Option) error

ListTypedLinkFacetAttributesPagesWithContext same as ListTypedLinkFacetAttributesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListTypedLinkFacetAttributesRequest added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetAttributesRequest(input *ListTypedLinkFacetAttributesInput) (req *request.Request, output *ListTypedLinkFacetAttributesOutput)

ListTypedLinkFacetAttributesRequest generates a "aws/request.Request" representing the client's request for the ListTypedLinkFacetAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTypedLinkFacetAttributes for more information on using the ListTypedLinkFacetAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTypedLinkFacetAttributesRequest method.
req, resp := client.ListTypedLinkFacetAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListTypedLinkFacetAttributes

func (*CloudDirectory) ListTypedLinkFacetAttributesWithContext added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetAttributesWithContext(ctx aws.Context, input *ListTypedLinkFacetAttributesInput, opts ...request.Option) (*ListTypedLinkFacetAttributesOutput, error)

ListTypedLinkFacetAttributesWithContext is the same as ListTypedLinkFacetAttributes with the addition of the ability to pass a context and additional request options.

See ListTypedLinkFacetAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListTypedLinkFacetNames added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetNames(input *ListTypedLinkFacetNamesInput) (*ListTypedLinkFacetNamesOutput, error)

ListTypedLinkFacetNames API operation for Amazon CloudDirectory.

Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation ListTypedLinkFacetNames for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListTypedLinkFacetNames

func (*CloudDirectory) ListTypedLinkFacetNamesPages added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetNamesPages(input *ListTypedLinkFacetNamesInput, fn func(*ListTypedLinkFacetNamesOutput, bool) bool) error

ListTypedLinkFacetNamesPages iterates over the pages of a ListTypedLinkFacetNames operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTypedLinkFacetNames method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTypedLinkFacetNames operation.
pageNum := 0
err := client.ListTypedLinkFacetNamesPages(params,
    func(page *clouddirectory.ListTypedLinkFacetNamesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) ListTypedLinkFacetNamesPagesWithContext added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetNamesPagesWithContext(ctx aws.Context, input *ListTypedLinkFacetNamesInput, fn func(*ListTypedLinkFacetNamesOutput, bool) bool, opts ...request.Option) error

ListTypedLinkFacetNamesPagesWithContext same as ListTypedLinkFacetNamesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) ListTypedLinkFacetNamesRequest added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetNamesRequest(input *ListTypedLinkFacetNamesInput) (req *request.Request, output *ListTypedLinkFacetNamesOutput)

ListTypedLinkFacetNamesRequest generates a "aws/request.Request" representing the client's request for the ListTypedLinkFacetNames operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTypedLinkFacetNames for more information on using the ListTypedLinkFacetNames API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTypedLinkFacetNamesRequest method.
req, resp := client.ListTypedLinkFacetNamesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/ListTypedLinkFacetNames

func (*CloudDirectory) ListTypedLinkFacetNamesWithContext added in v1.8.31

func (c *CloudDirectory) ListTypedLinkFacetNamesWithContext(ctx aws.Context, input *ListTypedLinkFacetNamesInput, opts ...request.Option) (*ListTypedLinkFacetNamesOutput, error)

ListTypedLinkFacetNamesWithContext is the same as ListTypedLinkFacetNames with the addition of the ability to pass a context and additional request options.

See ListTypedLinkFacetNames for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) LookupPolicy

func (c *CloudDirectory) LookupPolicy(input *LookupPolicyInput) (*LookupPolicyOutput, error)

LookupPolicy API operation for Amazon CloudDirectory.

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).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation LookupPolicy for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/LookupPolicy

func (*CloudDirectory) LookupPolicyPages

func (c *CloudDirectory) LookupPolicyPages(input *LookupPolicyInput, fn func(*LookupPolicyOutput, bool) bool) error

LookupPolicyPages iterates over the pages of a LookupPolicy operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See LookupPolicy method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a LookupPolicy operation.
pageNum := 0
err := client.LookupPolicyPages(params,
    func(page *clouddirectory.LookupPolicyOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudDirectory) LookupPolicyPagesWithContext added in v1.8.0

func (c *CloudDirectory) LookupPolicyPagesWithContext(ctx aws.Context, input *LookupPolicyInput, fn func(*LookupPolicyOutput, bool) bool, opts ...request.Option) error

LookupPolicyPagesWithContext same as LookupPolicyPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) LookupPolicyRequest

func (c *CloudDirectory) LookupPolicyRequest(input *LookupPolicyInput) (req *request.Request, output *LookupPolicyOutput)

LookupPolicyRequest generates a "aws/request.Request" representing the client's request for the LookupPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See LookupPolicy for more information on using the LookupPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the LookupPolicyRequest method.
req, resp := client.LookupPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/LookupPolicy

func (*CloudDirectory) LookupPolicyWithContext added in v1.8.0

func (c *CloudDirectory) LookupPolicyWithContext(ctx aws.Context, input *LookupPolicyInput, opts ...request.Option) (*LookupPolicyOutput, error)

LookupPolicyWithContext is the same as LookupPolicy with the addition of the ability to pass a context and additional request options.

See LookupPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) PublishSchema

func (c *CloudDirectory) PublishSchema(input *PublishSchemaInput) (*PublishSchemaOutput, error)

PublishSchema API operation for Amazon CloudDirectory.

Publishes a development schema with a major version and a recommended minor version.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation PublishSchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeSchemaAlreadyPublishedException "SchemaAlreadyPublishedException" Indicates that a schema is already published.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/PublishSchema

func (*CloudDirectory) PublishSchemaRequest

func (c *CloudDirectory) PublishSchemaRequest(input *PublishSchemaInput) (req *request.Request, output *PublishSchemaOutput)

PublishSchemaRequest generates a "aws/request.Request" representing the client's request for the PublishSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PublishSchema for more information on using the PublishSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PublishSchemaRequest method.
req, resp := client.PublishSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/PublishSchema

func (*CloudDirectory) PublishSchemaWithContext added in v1.8.0

func (c *CloudDirectory) PublishSchemaWithContext(ctx aws.Context, input *PublishSchemaInput, opts ...request.Option) (*PublishSchemaOutput, error)

PublishSchemaWithContext is the same as PublishSchema with the addition of the ability to pass a context and additional request options.

See PublishSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) PutSchemaFromJson

func (c *CloudDirectory) PutSchemaFromJson(input *PutSchemaFromJsonInput) (*PutSchemaFromJsonOutput, error)

PutSchemaFromJson API operation for Amazon CloudDirectory.

Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) for more information.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation PutSchemaFromJson for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeInvalidSchemaDocException "InvalidSchemaDocException" Indicates that the provided SchemaDoc value is not valid.

  • ErrCodeInvalidRuleException "InvalidRuleException" Occurs when any of the rule parameter keys or values are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/PutSchemaFromJson

func (*CloudDirectory) PutSchemaFromJsonRequest

func (c *CloudDirectory) PutSchemaFromJsonRequest(input *PutSchemaFromJsonInput) (req *request.Request, output *PutSchemaFromJsonOutput)

PutSchemaFromJsonRequest generates a "aws/request.Request" representing the client's request for the PutSchemaFromJson operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutSchemaFromJson for more information on using the PutSchemaFromJson API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutSchemaFromJsonRequest method.
req, resp := client.PutSchemaFromJsonRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/PutSchemaFromJson

func (*CloudDirectory) PutSchemaFromJsonWithContext added in v1.8.0

func (c *CloudDirectory) PutSchemaFromJsonWithContext(ctx aws.Context, input *PutSchemaFromJsonInput, opts ...request.Option) (*PutSchemaFromJsonOutput, error)

PutSchemaFromJsonWithContext is the same as PutSchemaFromJson with the addition of the ability to pass a context and additional request options.

See PutSchemaFromJson for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) RemoveFacetFromObject

func (c *CloudDirectory) RemoveFacetFromObject(input *RemoveFacetFromObjectInput) (*RemoveFacetFromObjectOutput, error)

RemoveFacetFromObject API operation for Amazon CloudDirectory.

Removes the specified facet from the specified object.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation RemoveFacetFromObject for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/RemoveFacetFromObject

func (*CloudDirectory) RemoveFacetFromObjectRequest

func (c *CloudDirectory) RemoveFacetFromObjectRequest(input *RemoveFacetFromObjectInput) (req *request.Request, output *RemoveFacetFromObjectOutput)

RemoveFacetFromObjectRequest generates a "aws/request.Request" representing the client's request for the RemoveFacetFromObject operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RemoveFacetFromObject for more information on using the RemoveFacetFromObject API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RemoveFacetFromObjectRequest method.
req, resp := client.RemoveFacetFromObjectRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/RemoveFacetFromObject

func (*CloudDirectory) RemoveFacetFromObjectWithContext added in v1.8.0

func (c *CloudDirectory) RemoveFacetFromObjectWithContext(ctx aws.Context, input *RemoveFacetFromObjectInput, opts ...request.Option) (*RemoveFacetFromObjectOutput, error)

RemoveFacetFromObjectWithContext is the same as RemoveFacetFromObject with the addition of the ability to pass a context and additional request options.

See RemoveFacetFromObject for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) TagResource

func (c *CloudDirectory) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for Amazon CloudDirectory.

An API operation for adding tags to a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation TagResource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidTaggingRequestException "InvalidTaggingRequestException" 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/TagResource

func (*CloudDirectory) TagResourceRequest

func (c *CloudDirectory) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/TagResource

func (*CloudDirectory) TagResourceWithContext added in v1.8.0

func (c *CloudDirectory) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UntagResource

func (c *CloudDirectory) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for Amazon CloudDirectory.

An API operation for removing tags from a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UntagResource for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidTaggingRequestException "InvalidTaggingRequestException" 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UntagResource

func (*CloudDirectory) UntagResourceRequest

func (c *CloudDirectory) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UntagResource

func (*CloudDirectory) UntagResourceWithContext added in v1.8.0

func (c *CloudDirectory) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpdateFacet

func (c *CloudDirectory) UpdateFacet(input *UpdateFacetInput) (*UpdateFacetOutput, error)

UpdateFacet API operation for Amazon CloudDirectory.

Does the following:

Adds new Attributes, Rules, or ObjectTypes.

Updates existing Attributes, Rules, or ObjectTypes.

Deletes existing Attributes, Rules, or ObjectTypes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpdateFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeInvalidFacetUpdateException "InvalidFacetUpdateException" An attempt to modify a Facet resulted in an invalid schema exception.

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

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

  • ErrCodeInvalidRuleException "InvalidRuleException" Occurs when any of the rule parameter keys or values are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateFacet

func (*CloudDirectory) UpdateFacetRequest

func (c *CloudDirectory) UpdateFacetRequest(input *UpdateFacetInput) (req *request.Request, output *UpdateFacetOutput)

UpdateFacetRequest generates a "aws/request.Request" representing the client's request for the UpdateFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFacet for more information on using the UpdateFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFacetRequest method.
req, resp := client.UpdateFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateFacet

func (*CloudDirectory) UpdateFacetWithContext added in v1.8.0

func (c *CloudDirectory) UpdateFacetWithContext(ctx aws.Context, input *UpdateFacetInput, opts ...request.Option) (*UpdateFacetOutput, error)

UpdateFacetWithContext is the same as UpdateFacet with the addition of the ability to pass a context and additional request options.

See UpdateFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpdateLinkAttributes added in v1.14.4

func (c *CloudDirectory) UpdateLinkAttributes(input *UpdateLinkAttributesInput) (*UpdateLinkAttributesOutput, error)

UpdateLinkAttributes API operation for Amazon CloudDirectory.

Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpdateLinkAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateLinkAttributes

func (*CloudDirectory) UpdateLinkAttributesRequest added in v1.14.4

func (c *CloudDirectory) UpdateLinkAttributesRequest(input *UpdateLinkAttributesInput) (req *request.Request, output *UpdateLinkAttributesOutput)

UpdateLinkAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateLinkAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLinkAttributes for more information on using the UpdateLinkAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateLinkAttributesRequest method.
req, resp := client.UpdateLinkAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateLinkAttributes

func (*CloudDirectory) UpdateLinkAttributesWithContext added in v1.14.4

func (c *CloudDirectory) UpdateLinkAttributesWithContext(ctx aws.Context, input *UpdateLinkAttributesInput, opts ...request.Option) (*UpdateLinkAttributesOutput, error)

UpdateLinkAttributesWithContext is the same as UpdateLinkAttributes with the addition of the ability to pass a context and additional request options.

See UpdateLinkAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpdateObjectAttributes

func (c *CloudDirectory) UpdateObjectAttributes(input *UpdateObjectAttributesInput) (*UpdateObjectAttributesOutput, error)

UpdateObjectAttributes API operation for Amazon CloudDirectory.

Updates a given object's attributes.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpdateObjectAttributes for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" Operations are only permitted on enabled directories.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateObjectAttributes

func (*CloudDirectory) UpdateObjectAttributesRequest

func (c *CloudDirectory) UpdateObjectAttributesRequest(input *UpdateObjectAttributesInput) (req *request.Request, output *UpdateObjectAttributesOutput)

UpdateObjectAttributesRequest generates a "aws/request.Request" representing the client's request for the UpdateObjectAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateObjectAttributes for more information on using the UpdateObjectAttributes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateObjectAttributesRequest method.
req, resp := client.UpdateObjectAttributesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateObjectAttributes

func (*CloudDirectory) UpdateObjectAttributesWithContext added in v1.8.0

func (c *CloudDirectory) UpdateObjectAttributesWithContext(ctx aws.Context, input *UpdateObjectAttributesInput, opts ...request.Option) (*UpdateObjectAttributesOutput, error)

UpdateObjectAttributesWithContext is the same as UpdateObjectAttributes with the addition of the ability to pass a context and additional request options.

See UpdateObjectAttributes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpdateSchema

func (c *CloudDirectory) UpdateSchema(input *UpdateSchemaInput) (*UpdateSchemaOutput, error)

UpdateSchema API operation for Amazon CloudDirectory.

Updates the schema name with a new name. Only development schema names can be updated.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpdateSchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateSchema

func (*CloudDirectory) UpdateSchemaRequest

func (c *CloudDirectory) UpdateSchemaRequest(input *UpdateSchemaInput) (req *request.Request, output *UpdateSchemaOutput)

UpdateSchemaRequest generates a "aws/request.Request" representing the client's request for the UpdateSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSchema for more information on using the UpdateSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSchemaRequest method.
req, resp := client.UpdateSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateSchema

func (*CloudDirectory) UpdateSchemaWithContext added in v1.8.0

func (c *CloudDirectory) UpdateSchemaWithContext(ctx aws.Context, input *UpdateSchemaInput, opts ...request.Option) (*UpdateSchemaOutput, error)

UpdateSchemaWithContext is the same as UpdateSchema with the addition of the ability to pass a context and additional request options.

See UpdateSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpdateTypedLinkFacet added in v1.8.31

func (c *CloudDirectory) UpdateTypedLinkFacet(input *UpdateTypedLinkFacetInput) (*UpdateTypedLinkFacetOutput, error)

UpdateTypedLinkFacet API operation for Amazon CloudDirectory.

Updates a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpdateTypedLinkFacet for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

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

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

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

  • ErrCodeInvalidFacetUpdateException "InvalidFacetUpdateException" An attempt to modify a Facet resulted in an invalid schema exception.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeFacetNotFoundException "FacetNotFoundException" The specified Facet could not be found.

  • ErrCodeInvalidRuleException "InvalidRuleException" Occurs when any of the rule parameter keys or values are invalid.

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateTypedLinkFacet

func (*CloudDirectory) UpdateTypedLinkFacetRequest added in v1.8.31

func (c *CloudDirectory) UpdateTypedLinkFacetRequest(input *UpdateTypedLinkFacetInput) (req *request.Request, output *UpdateTypedLinkFacetOutput)

UpdateTypedLinkFacetRequest generates a "aws/request.Request" representing the client's request for the UpdateTypedLinkFacet operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateTypedLinkFacet for more information on using the UpdateTypedLinkFacet API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateTypedLinkFacetRequest method.
req, resp := client.UpdateTypedLinkFacetRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpdateTypedLinkFacet

func (*CloudDirectory) UpdateTypedLinkFacetWithContext added in v1.8.31

func (c *CloudDirectory) UpdateTypedLinkFacetWithContext(ctx aws.Context, input *UpdateTypedLinkFacetInput, opts ...request.Option) (*UpdateTypedLinkFacetOutput, error)

UpdateTypedLinkFacetWithContext is the same as UpdateTypedLinkFacet with the addition of the ability to pass a context and additional request options.

See UpdateTypedLinkFacet for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpgradeAppliedSchema added in v1.12.43

func (c *CloudDirectory) UpgradeAppliedSchema(input *UpgradeAppliedSchemaInput) (*UpgradeAppliedSchemaOutput, error)

UpgradeAppliedSchema API operation for Amazon CloudDirectory.

Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpgradeAppliedSchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

  • ErrCodeIncompatibleSchemaException "IncompatibleSchemaException" 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.

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpgradeAppliedSchema

func (*CloudDirectory) UpgradeAppliedSchemaRequest added in v1.12.43

func (c *CloudDirectory) UpgradeAppliedSchemaRequest(input *UpgradeAppliedSchemaInput) (req *request.Request, output *UpgradeAppliedSchemaOutput)

UpgradeAppliedSchemaRequest generates a "aws/request.Request" representing the client's request for the UpgradeAppliedSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpgradeAppliedSchema for more information on using the UpgradeAppliedSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpgradeAppliedSchemaRequest method.
req, resp := client.UpgradeAppliedSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpgradeAppliedSchema

func (*CloudDirectory) UpgradeAppliedSchemaWithContext added in v1.12.43

func (c *CloudDirectory) UpgradeAppliedSchemaWithContext(ctx aws.Context, input *UpgradeAppliedSchemaInput, opts ...request.Option) (*UpgradeAppliedSchemaOutput, error)

UpgradeAppliedSchemaWithContext is the same as UpgradeAppliedSchema with the addition of the ability to pass a context and additional request options.

See UpgradeAppliedSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudDirectory) UpgradePublishedSchema added in v1.12.43

func (c *CloudDirectory) UpgradePublishedSchema(input *UpgradePublishedSchemaInput) (*UpgradePublishedSchemaOutput, error)

UpgradePublishedSchema API operation for Amazon CloudDirectory.

Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for Amazon CloudDirectory's API operation UpgradePublishedSchema for usage and error information.

Returned Error Codes:

  • ErrCodeInternalServiceException "InternalServiceException" 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.

  • ErrCodeInvalidArnException "InvalidArnException" Indicates that the provided ARN value is not valid.

  • ErrCodeRetryableConflictException "RetryableConflictException" 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.

  • ErrCodeValidationException "ValidationException" Indicates that your request is malformed in some manner. See the exception message.

  • ErrCodeIncompatibleSchemaException "IncompatibleSchemaException" 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.

  • ErrCodeAccessDeniedException "AccessDeniedException" Access denied. Check your permissions.

  • ErrCodeResourceNotFoundException "ResourceNotFoundException" The specified resource could not be found.

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" 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.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpgradePublishedSchema

func (*CloudDirectory) UpgradePublishedSchemaRequest added in v1.12.43

func (c *CloudDirectory) UpgradePublishedSchemaRequest(input *UpgradePublishedSchemaInput) (req *request.Request, output *UpgradePublishedSchemaOutput)

UpgradePublishedSchemaRequest generates a "aws/request.Request" representing the client's request for the UpgradePublishedSchema operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpgradePublishedSchema for more information on using the UpgradePublishedSchema API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpgradePublishedSchemaRequest method.
req, resp := client.UpgradePublishedSchemaRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2017-01-11/UpgradePublishedSchema

func (*CloudDirectory) UpgradePublishedSchemaWithContext added in v1.12.43

func (c *CloudDirectory) UpgradePublishedSchemaWithContext(ctx aws.Context, input *UpgradePublishedSchemaInput, opts ...request.Option) (*UpgradePublishedSchemaOutput, error)

UpgradePublishedSchemaWithContext is the same as UpgradePublishedSchema with the addition of the ability to pass a context and additional request options.

See UpgradePublishedSchema for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CreateDirectoryInput

type CreateDirectoryInput struct {

	// The name of the Directory. Should be unique per account, per region.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the published schema that will be copied
	// into the data Directory. For more information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDirectoryInput) GoString

func (s CreateDirectoryInput) GoString() string

GoString returns the string representation

func (*CreateDirectoryInput) SetName

SetName sets the Name field's value.

func (*CreateDirectoryInput) SetSchemaArn

func (s *CreateDirectoryInput) SetSchemaArn(v string) *CreateDirectoryInput

SetSchemaArn sets the SchemaArn field's value.

func (CreateDirectoryInput) String

func (s CreateDirectoryInput) String() string

String returns the string representation

func (*CreateDirectoryInput) Validate

func (s *CreateDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateDirectoryOutput

type CreateDirectoryOutput struct {

	// The ARN of the published schema in the Directory. Once a published schema
	// is copied into the directory, it has its own ARN, which is referred to applied
	// schema ARN. For more information, see arns.
	//
	// AppliedSchemaArn is a required field
	AppliedSchemaArn *string `type:"string" required:"true"`

	// The ARN that is associated with the Directory. For more information, see
	// arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`

	// The name of the Directory.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The root object node of the created directory.
	//
	// ObjectIdentifier is a required field
	ObjectIdentifier *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateDirectoryOutput) GoString

func (s CreateDirectoryOutput) GoString() string

GoString returns the string representation

func (*CreateDirectoryOutput) SetAppliedSchemaArn

func (s *CreateDirectoryOutput) SetAppliedSchemaArn(v string) *CreateDirectoryOutput

SetAppliedSchemaArn sets the AppliedSchemaArn field's value.

func (*CreateDirectoryOutput) SetDirectoryArn

func (s *CreateDirectoryOutput) SetDirectoryArn(v string) *CreateDirectoryOutput

SetDirectoryArn sets the DirectoryArn field's value.

func (*CreateDirectoryOutput) SetName

SetName sets the Name field's value.

func (*CreateDirectoryOutput) SetObjectIdentifier

func (s *CreateDirectoryOutput) SetObjectIdentifier(v string) *CreateDirectoryOutput

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (CreateDirectoryOutput) String

func (s CreateDirectoryOutput) String() string

String returns the string representation

type CreateFacetInput

type CreateFacetInput struct {

	// The attributes that are associated with the Facet.
	Attributes []*FacetAttribute `type:"list"`

	// 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 *string `type:"string" enum:"FacetStyle"`

	// The name of the Facet, which is unique for a given schema.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).
	//
	//    * Index: Can be created with the Index API.
	ObjectType *string `type:"string" enum:"ObjectType"`

	// The schema ARN in which the new Facet will be created. For more information,
	// see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFacetInput) GoString

func (s CreateFacetInput) GoString() string

GoString returns the string representation

func (*CreateFacetInput) SetAttributes

func (s *CreateFacetInput) SetAttributes(v []*FacetAttribute) *CreateFacetInput

SetAttributes sets the Attributes field's value.

func (*CreateFacetInput) SetFacetStyle added in v1.14.12

func (s *CreateFacetInput) SetFacetStyle(v string) *CreateFacetInput

SetFacetStyle sets the FacetStyle field's value.

func (*CreateFacetInput) SetName

func (s *CreateFacetInput) SetName(v string) *CreateFacetInput

SetName sets the Name field's value.

func (*CreateFacetInput) SetObjectType

func (s *CreateFacetInput) SetObjectType(v string) *CreateFacetInput

SetObjectType sets the ObjectType field's value.

func (*CreateFacetInput) SetSchemaArn

func (s *CreateFacetInput) SetSchemaArn(v string) *CreateFacetInput

SetSchemaArn sets the SchemaArn field's value.

func (CreateFacetInput) String

func (s CreateFacetInput) String() string

String returns the string representation

func (*CreateFacetInput) Validate

func (s *CreateFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFacetOutput

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

func (CreateFacetOutput) GoString

func (s CreateFacetOutput) GoString() string

GoString returns the string representation

func (CreateFacetOutput) String

func (s CreateFacetOutput) String() string

String returns the string representation

type CreateIndexInput

type CreateIndexInput struct {

	// The ARN of the directory where the index should be created.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Indicates whether the attribute that is being indexed has unique values or
	// not.
	//
	// IsUnique is a required field
	IsUnique *bool `type:"boolean" required:"true"`

	// The name of the link between the parent object and the index object.
	LinkName *string `min:"1" type:"string"`

	// Specifies the attributes that should be indexed on. Currently only a single
	// attribute is supported.
	//
	// OrderedIndexedAttributeList is a required field
	OrderedIndexedAttributeList []*AttributeKey `type:"list" required:"true"`

	// A reference to the parent object that contains the index object.
	ParentReference *ObjectReference `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateIndexInput) GoString

func (s CreateIndexInput) GoString() string

GoString returns the string representation

func (*CreateIndexInput) SetDirectoryArn

func (s *CreateIndexInput) SetDirectoryArn(v string) *CreateIndexInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*CreateIndexInput) SetIsUnique

func (s *CreateIndexInput) SetIsUnique(v bool) *CreateIndexInput

SetIsUnique sets the IsUnique field's value.

func (*CreateIndexInput) SetLinkName

func (s *CreateIndexInput) SetLinkName(v string) *CreateIndexInput

SetLinkName sets the LinkName field's value.

func (*CreateIndexInput) SetOrderedIndexedAttributeList

func (s *CreateIndexInput) SetOrderedIndexedAttributeList(v []*AttributeKey) *CreateIndexInput

SetOrderedIndexedAttributeList sets the OrderedIndexedAttributeList field's value.

func (*CreateIndexInput) SetParentReference

func (s *CreateIndexInput) SetParentReference(v *ObjectReference) *CreateIndexInput

SetParentReference sets the ParentReference field's value.

func (CreateIndexInput) String

func (s CreateIndexInput) String() string

String returns the string representation

func (*CreateIndexInput) Validate

func (s *CreateIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateIndexOutput

type CreateIndexOutput struct {

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

func (CreateIndexOutput) GoString

func (s CreateIndexOutput) GoString() string

GoString returns the string representation

func (*CreateIndexOutput) SetObjectIdentifier

func (s *CreateIndexOutput) SetObjectIdentifier(v string) *CreateIndexOutput

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (CreateIndexOutput) String

func (s CreateIndexOutput) String() string

String returns the string representation

type CreateObjectInput

type CreateObjectInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory in which
	// the object will be created. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The name of link that is used to attach this object to a parent.
	LinkName *string `min:"1" type:"string"`

	// The attribute map whose attribute ARN contains the key and attribute value
	// as the map value.
	ObjectAttributeList []*AttributeKeyAndValue `type:"list"`

	// If specified, the parent reference to which this object will be attached.
	ParentReference *ObjectReference `type:"structure"`

	// A list of schema facets to be associated with the object. Do not provide
	// minor version components. See SchemaFacet for details.
	//
	// SchemaFacets is a required field
	SchemaFacets []*SchemaFacet `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateObjectInput) GoString

func (s CreateObjectInput) GoString() string

GoString returns the string representation

func (*CreateObjectInput) SetDirectoryArn

func (s *CreateObjectInput) SetDirectoryArn(v string) *CreateObjectInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*CreateObjectInput) SetLinkName

func (s *CreateObjectInput) SetLinkName(v string) *CreateObjectInput

SetLinkName sets the LinkName field's value.

func (*CreateObjectInput) SetObjectAttributeList

func (s *CreateObjectInput) SetObjectAttributeList(v []*AttributeKeyAndValue) *CreateObjectInput

SetObjectAttributeList sets the ObjectAttributeList field's value.

func (*CreateObjectInput) SetParentReference

func (s *CreateObjectInput) SetParentReference(v *ObjectReference) *CreateObjectInput

SetParentReference sets the ParentReference field's value.

func (*CreateObjectInput) SetSchemaFacets

func (s *CreateObjectInput) SetSchemaFacets(v []*SchemaFacet) *CreateObjectInput

SetSchemaFacets sets the SchemaFacets field's value.

func (CreateObjectInput) String

func (s CreateObjectInput) String() string

String returns the string representation

func (*CreateObjectInput) Validate

func (s *CreateObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateObjectOutput

type CreateObjectOutput struct {

	// The identifier that is associated with the object.
	ObjectIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateObjectOutput) GoString

func (s CreateObjectOutput) GoString() string

GoString returns the string representation

func (*CreateObjectOutput) SetObjectIdentifier

func (s *CreateObjectOutput) SetObjectIdentifier(v string) *CreateObjectOutput

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (CreateObjectOutput) String

func (s CreateObjectOutput) String() string

String returns the string representation

type CreateSchemaInput

type CreateSchemaInput struct {

	// The name that is associated with the schema. This is unique to each account
	// and in each region.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateSchemaInput) GoString

func (s CreateSchemaInput) GoString() string

GoString returns the string representation

func (*CreateSchemaInput) SetName

SetName sets the Name field's value.

func (CreateSchemaInput) String

func (s CreateSchemaInput) String() string

String returns the string representation

func (*CreateSchemaInput) Validate

func (s *CreateSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateSchemaOutput

type CreateSchemaOutput struct {

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateSchemaOutput) GoString

func (s CreateSchemaOutput) GoString() string

GoString returns the string representation

func (*CreateSchemaOutput) SetSchemaArn

func (s *CreateSchemaOutput) SetSchemaArn(v string) *CreateSchemaOutput

SetSchemaArn sets the SchemaArn field's value.

func (CreateSchemaOutput) String

func (s CreateSchemaOutput) String() string

String returns the string representation

type CreateTypedLinkFacetInput added in v1.8.31

type CreateTypedLinkFacetInput struct {

	// Facet structure that is associated with the typed link facet.
	//
	// Facet is a required field
	Facet *TypedLinkFacet `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateTypedLinkFacetInput) GoString added in v1.8.31

func (s CreateTypedLinkFacetInput) GoString() string

GoString returns the string representation

func (*CreateTypedLinkFacetInput) SetFacet added in v1.8.31

SetFacet sets the Facet field's value.

func (*CreateTypedLinkFacetInput) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (CreateTypedLinkFacetInput) String added in v1.8.31

func (s CreateTypedLinkFacetInput) String() string

String returns the string representation

func (*CreateTypedLinkFacetInput) Validate added in v1.8.31

func (s *CreateTypedLinkFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateTypedLinkFacetOutput added in v1.8.31

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

func (CreateTypedLinkFacetOutput) GoString added in v1.8.31

func (s CreateTypedLinkFacetOutput) GoString() string

GoString returns the string representation

func (CreateTypedLinkFacetOutput) String added in v1.8.31

String returns the string representation

type DeleteDirectoryInput

type DeleteDirectoryInput struct {

	// The ARN of the directory to delete.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDirectoryInput) GoString

func (s DeleteDirectoryInput) GoString() string

GoString returns the string representation

func (*DeleteDirectoryInput) SetDirectoryArn

func (s *DeleteDirectoryInput) SetDirectoryArn(v string) *DeleteDirectoryInput

SetDirectoryArn sets the DirectoryArn field's value.

func (DeleteDirectoryInput) String

func (s DeleteDirectoryInput) String() string

String returns the string representation

func (*DeleteDirectoryInput) Validate

func (s *DeleteDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteDirectoryOutput

type DeleteDirectoryOutput struct {

	// The ARN of the deleted directory.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteDirectoryOutput) GoString

func (s DeleteDirectoryOutput) GoString() string

GoString returns the string representation

func (*DeleteDirectoryOutput) SetDirectoryArn

func (s *DeleteDirectoryOutput) SetDirectoryArn(v string) *DeleteDirectoryOutput

SetDirectoryArn sets the DirectoryArn field's value.

func (DeleteDirectoryOutput) String

func (s DeleteDirectoryOutput) String() string

String returns the string representation

type DeleteFacetInput

type DeleteFacetInput struct {

	// The name of the facet to delete.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the Facet. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFacetInput) GoString

func (s DeleteFacetInput) GoString() string

GoString returns the string representation

func (*DeleteFacetInput) SetName

func (s *DeleteFacetInput) SetName(v string) *DeleteFacetInput

SetName sets the Name field's value.

func (*DeleteFacetInput) SetSchemaArn

func (s *DeleteFacetInput) SetSchemaArn(v string) *DeleteFacetInput

SetSchemaArn sets the SchemaArn field's value.

func (DeleteFacetInput) String

func (s DeleteFacetInput) String() string

String returns the string representation

func (*DeleteFacetInput) Validate

func (s *DeleteFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFacetOutput

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

func (DeleteFacetOutput) GoString

func (s DeleteFacetOutput) GoString() string

GoString returns the string representation

func (DeleteFacetOutput) String

func (s DeleteFacetOutput) String() string

String returns the string representation

type DeleteObjectInput

type DeleteObjectInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A reference that identifies the object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteObjectInput) GoString

func (s DeleteObjectInput) GoString() string

GoString returns the string representation

func (*DeleteObjectInput) SetDirectoryArn

func (s *DeleteObjectInput) SetDirectoryArn(v string) *DeleteObjectInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*DeleteObjectInput) SetObjectReference

func (s *DeleteObjectInput) SetObjectReference(v *ObjectReference) *DeleteObjectInput

SetObjectReference sets the ObjectReference field's value.

func (DeleteObjectInput) String

func (s DeleteObjectInput) String() string

String returns the string representation

func (*DeleteObjectInput) Validate

func (s *DeleteObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteObjectOutput

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

func (DeleteObjectOutput) GoString

func (s DeleteObjectOutput) GoString() string

GoString returns the string representation

func (DeleteObjectOutput) String

func (s DeleteObjectOutput) String() string

String returns the string representation

type DeleteSchemaInput

type DeleteSchemaInput struct {

	// The Amazon Resource Name (ARN) of the development schema. For more information,
	// see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteSchemaInput) GoString

func (s DeleteSchemaInput) GoString() string

GoString returns the string representation

func (*DeleteSchemaInput) SetSchemaArn

func (s *DeleteSchemaInput) SetSchemaArn(v string) *DeleteSchemaInput

SetSchemaArn sets the SchemaArn field's value.

func (DeleteSchemaInput) String

func (s DeleteSchemaInput) String() string

String returns the string representation

func (*DeleteSchemaInput) Validate

func (s *DeleteSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteSchemaOutput

type DeleteSchemaOutput struct {

	// The input ARN that is returned as part of the response. For more information,
	// see arns.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteSchemaOutput) GoString

func (s DeleteSchemaOutput) GoString() string

GoString returns the string representation

func (*DeleteSchemaOutput) SetSchemaArn

func (s *DeleteSchemaOutput) SetSchemaArn(v string) *DeleteSchemaOutput

SetSchemaArn sets the SchemaArn field's value.

func (DeleteSchemaOutput) String

func (s DeleteSchemaOutput) String() string

String returns the string representation

type DeleteTypedLinkFacetInput added in v1.8.31

type DeleteTypedLinkFacetInput struct {

	// The unique name of the typed link facet.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteTypedLinkFacetInput) GoString added in v1.8.31

func (s DeleteTypedLinkFacetInput) GoString() string

GoString returns the string representation

func (*DeleteTypedLinkFacetInput) SetName added in v1.8.31

SetName sets the Name field's value.

func (*DeleteTypedLinkFacetInput) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (DeleteTypedLinkFacetInput) String added in v1.8.31

func (s DeleteTypedLinkFacetInput) String() string

String returns the string representation

func (*DeleteTypedLinkFacetInput) Validate added in v1.8.31

func (s *DeleteTypedLinkFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteTypedLinkFacetOutput added in v1.8.31

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

func (DeleteTypedLinkFacetOutput) GoString added in v1.8.31

func (s DeleteTypedLinkFacetOutput) GoString() string

GoString returns the string representation

func (DeleteTypedLinkFacetOutput) String added in v1.8.31

String returns the string representation

type DetachFromIndexInput

type DetachFromIndexInput struct {

	// The Amazon Resource Name (ARN) of the directory the index and object exist
	// in.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A reference to the index object.
	//
	// IndexReference is a required field
	IndexReference *ObjectReference `type:"structure" required:"true"`

	// A reference to the object being detached from the index.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetachFromIndexInput) GoString

func (s DetachFromIndexInput) GoString() string

GoString returns the string representation

func (*DetachFromIndexInput) SetDirectoryArn

func (s *DetachFromIndexInput) SetDirectoryArn(v string) *DetachFromIndexInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*DetachFromIndexInput) SetIndexReference

func (s *DetachFromIndexInput) SetIndexReference(v *ObjectReference) *DetachFromIndexInput

SetIndexReference sets the IndexReference field's value.

func (*DetachFromIndexInput) SetTargetReference

func (s *DetachFromIndexInput) SetTargetReference(v *ObjectReference) *DetachFromIndexInput

SetTargetReference sets the TargetReference field's value.

func (DetachFromIndexInput) String

func (s DetachFromIndexInput) String() string

String returns the string representation

func (*DetachFromIndexInput) Validate

func (s *DetachFromIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetachFromIndexOutput

type DetachFromIndexOutput struct {

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

func (DetachFromIndexOutput) GoString

func (s DetachFromIndexOutput) GoString() string

GoString returns the string representation

func (*DetachFromIndexOutput) SetDetachedObjectIdentifier

func (s *DetachFromIndexOutput) SetDetachedObjectIdentifier(v string) *DetachFromIndexOutput

SetDetachedObjectIdentifier sets the DetachedObjectIdentifier field's value.

func (DetachFromIndexOutput) String

func (s DetachFromIndexOutput) String() string

String returns the string representation

type DetachObjectInput

type DetachObjectInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// objects reside. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The link name associated with the object that needs to be detached.
	//
	// LinkName is a required field
	LinkName *string `min:"1" type:"string" required:"true"`

	// The parent reference from which the object with the specified link name is
	// detached.
	//
	// ParentReference is a required field
	ParentReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetachObjectInput) GoString

func (s DetachObjectInput) GoString() string

GoString returns the string representation

func (*DetachObjectInput) SetDirectoryArn

func (s *DetachObjectInput) SetDirectoryArn(v string) *DetachObjectInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*DetachObjectInput) SetLinkName

func (s *DetachObjectInput) SetLinkName(v string) *DetachObjectInput

SetLinkName sets the LinkName field's value.

func (*DetachObjectInput) SetParentReference

func (s *DetachObjectInput) SetParentReference(v *ObjectReference) *DetachObjectInput

SetParentReference sets the ParentReference field's value.

func (DetachObjectInput) String

func (s DetachObjectInput) String() string

String returns the string representation

func (*DetachObjectInput) Validate

func (s *DetachObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetachObjectOutput

type DetachObjectOutput struct {

	// The ObjectIdentifier that was detached from the object.
	DetachedObjectIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (DetachObjectOutput) GoString

func (s DetachObjectOutput) GoString() string

GoString returns the string representation

func (*DetachObjectOutput) SetDetachedObjectIdentifier

func (s *DetachObjectOutput) SetDetachedObjectIdentifier(v string) *DetachObjectOutput

SetDetachedObjectIdentifier sets the DetachedObjectIdentifier field's value.

func (DetachObjectOutput) String

func (s DetachObjectOutput) String() string

String returns the string representation

type DetachPolicyInput

type DetachPolicyInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// both objects reside. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Reference that identifies the object whose policy object will be detached.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// Reference that identifies the policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetachPolicyInput) GoString

func (s DetachPolicyInput) GoString() string

GoString returns the string representation

func (*DetachPolicyInput) SetDirectoryArn

func (s *DetachPolicyInput) SetDirectoryArn(v string) *DetachPolicyInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*DetachPolicyInput) SetObjectReference

func (s *DetachPolicyInput) SetObjectReference(v *ObjectReference) *DetachPolicyInput

SetObjectReference sets the ObjectReference field's value.

func (*DetachPolicyInput) SetPolicyReference

func (s *DetachPolicyInput) SetPolicyReference(v *ObjectReference) *DetachPolicyInput

SetPolicyReference sets the PolicyReference field's value.

func (DetachPolicyInput) String

func (s DetachPolicyInput) String() string

String returns the string representation

func (*DetachPolicyInput) Validate

func (s *DetachPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetachPolicyOutput

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

func (DetachPolicyOutput) GoString

func (s DetachPolicyOutput) GoString() string

GoString returns the string representation

func (DetachPolicyOutput) String

func (s DetachPolicyOutput) String() string

String returns the string representation

type DetachTypedLinkInput added in v1.8.31

type DetachTypedLinkInput struct {

	// The Amazon Resource Name (ARN) of the directory where you want to detach
	// the typed link.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Used to accept a typed link specifier as input.
	//
	// TypedLinkSpecifier is a required field
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DetachTypedLinkInput) GoString added in v1.8.31

func (s DetachTypedLinkInput) GoString() string

GoString returns the string representation

func (*DetachTypedLinkInput) SetDirectoryArn added in v1.8.31

func (s *DetachTypedLinkInput) SetDirectoryArn(v string) *DetachTypedLinkInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*DetachTypedLinkInput) SetTypedLinkSpecifier added in v1.8.31

func (s *DetachTypedLinkInput) SetTypedLinkSpecifier(v *TypedLinkSpecifier) *DetachTypedLinkInput

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (DetachTypedLinkInput) String added in v1.8.31

func (s DetachTypedLinkInput) String() string

String returns the string representation

func (*DetachTypedLinkInput) Validate added in v1.8.31

func (s *DetachTypedLinkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DetachTypedLinkOutput added in v1.8.31

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

func (DetachTypedLinkOutput) GoString added in v1.8.31

func (s DetachTypedLinkOutput) GoString() string

GoString returns the string representation

func (DetachTypedLinkOutput) String added in v1.8.31

func (s DetachTypedLinkOutput) String() string

String returns the string representation

type Directory

type Directory struct {

	// The date and time when the directory was created.
	CreationDateTime *time.Time `type:"timestamp"`

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

	// The name of the directory.
	Name *string `min:"1" type:"string"`

	// The state of the directory. Can be either Enabled, Disabled, or Deleted.
	State *string `type:"string" enum:"DirectoryState"`
	// contains filtered or unexported fields
}

Directory structure that includes the directory name and directory ARN.

func (Directory) GoString

func (s Directory) GoString() string

GoString returns the string representation

func (*Directory) SetCreationDateTime

func (s *Directory) SetCreationDateTime(v time.Time) *Directory

SetCreationDateTime sets the CreationDateTime field's value.

func (*Directory) SetDirectoryArn

func (s *Directory) SetDirectoryArn(v string) *Directory

SetDirectoryArn sets the DirectoryArn field's value.

func (*Directory) SetName

func (s *Directory) SetName(v string) *Directory

SetName sets the Name field's value.

func (*Directory) SetState

func (s *Directory) SetState(v string) *Directory

SetState sets the State field's value.

func (Directory) String

func (s Directory) String() string

String returns the string representation

type DisableDirectoryInput

type DisableDirectoryInput struct {

	// The ARN of the directory to disable.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableDirectoryInput) GoString

func (s DisableDirectoryInput) GoString() string

GoString returns the string representation

func (*DisableDirectoryInput) SetDirectoryArn

func (s *DisableDirectoryInput) SetDirectoryArn(v string) *DisableDirectoryInput

SetDirectoryArn sets the DirectoryArn field's value.

func (DisableDirectoryInput) String

func (s DisableDirectoryInput) String() string

String returns the string representation

func (*DisableDirectoryInput) Validate

func (s *DisableDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisableDirectoryOutput

type DisableDirectoryOutput struct {

	// The ARN of the directory that has been disabled.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisableDirectoryOutput) GoString

func (s DisableDirectoryOutput) GoString() string

GoString returns the string representation

func (*DisableDirectoryOutput) SetDirectoryArn

func (s *DisableDirectoryOutput) SetDirectoryArn(v string) *DisableDirectoryOutput

SetDirectoryArn sets the DirectoryArn field's value.

func (DisableDirectoryOutput) String

func (s DisableDirectoryOutput) String() string

String returns the string representation

type EnableDirectoryInput

type EnableDirectoryInput struct {

	// The ARN of the directory to enable.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableDirectoryInput) GoString

func (s EnableDirectoryInput) GoString() string

GoString returns the string representation

func (*EnableDirectoryInput) SetDirectoryArn

func (s *EnableDirectoryInput) SetDirectoryArn(v string) *EnableDirectoryInput

SetDirectoryArn sets the DirectoryArn field's value.

func (EnableDirectoryInput) String

func (s EnableDirectoryInput) String() string

String returns the string representation

func (*EnableDirectoryInput) Validate

func (s *EnableDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type EnableDirectoryOutput

type EnableDirectoryOutput struct {

	// The ARN of the enabled directory.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (EnableDirectoryOutput) GoString

func (s EnableDirectoryOutput) GoString() string

GoString returns the string representation

func (*EnableDirectoryOutput) SetDirectoryArn

func (s *EnableDirectoryOutput) SetDirectoryArn(v string) *EnableDirectoryOutput

SetDirectoryArn sets the DirectoryArn field's value.

func (EnableDirectoryOutput) String

func (s EnableDirectoryOutput) String() string

String returns the string representation

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 *string `type:"string" enum:"FacetStyle"`

	// The name of the Facet.
	Name *string `min:"1" type:"string"`

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

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

func (Facet) GoString

func (s Facet) GoString() string

GoString returns the string representation

func (*Facet) SetFacetStyle added in v1.14.12

func (s *Facet) SetFacetStyle(v string) *Facet

SetFacetStyle sets the FacetStyle field's value.

func (*Facet) SetName

func (s *Facet) SetName(v string) *Facet

SetName sets the Name field's value.

func (*Facet) SetObjectType

func (s *Facet) SetObjectType(v string) *Facet

SetObjectType sets the ObjectType field's value.

func (Facet) String

func (s Facet) String() string

String returns the string representation

type FacetAttribute

type FacetAttribute struct {

	// 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 `type:"structure"`

	// 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 `type:"structure"`

	// The name of the facet attribute.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The required behavior of the FacetAttribute.
	RequiredBehavior *string `type:"string" enum:"RequiredAttributeBehavior"`
	// contains filtered or unexported fields
}

An attribute that is associated with the Facet.

func (FacetAttribute) GoString

func (s FacetAttribute) GoString() string

GoString returns the string representation

func (*FacetAttribute) SetAttributeDefinition

func (s *FacetAttribute) SetAttributeDefinition(v *FacetAttributeDefinition) *FacetAttribute

SetAttributeDefinition sets the AttributeDefinition field's value.

func (*FacetAttribute) SetAttributeReference

func (s *FacetAttribute) SetAttributeReference(v *FacetAttributeReference) *FacetAttribute

SetAttributeReference sets the AttributeReference field's value.

func (*FacetAttribute) SetName

func (s *FacetAttribute) SetName(v string) *FacetAttribute

SetName sets the Name field's value.

func (*FacetAttribute) SetRequiredBehavior

func (s *FacetAttribute) SetRequiredBehavior(v string) *FacetAttribute

SetRequiredBehavior sets the RequiredBehavior field's value.

func (FacetAttribute) String

func (s FacetAttribute) String() string

String returns the string representation

func (*FacetAttribute) Validate

func (s *FacetAttribute) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FacetAttributeDefinition

type FacetAttributeDefinition struct {

	// The default value of the attribute (if configured).
	DefaultValue *TypedAttributeValue `type:"structure"`

	// Whether the attribute is mutable or not.
	IsImmutable *bool `type:"boolean"`

	// Validation rules attached to the attribute definition.
	Rules map[string]*Rule `type:"map"`

	// The type of the attribute.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"FacetAttributeType"`
	// 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.

func (FacetAttributeDefinition) GoString

func (s FacetAttributeDefinition) GoString() string

GoString returns the string representation

func (*FacetAttributeDefinition) SetDefaultValue

SetDefaultValue sets the DefaultValue field's value.

func (*FacetAttributeDefinition) SetIsImmutable

SetIsImmutable sets the IsImmutable field's value.

func (*FacetAttributeDefinition) SetRules

SetRules sets the Rules field's value.

func (*FacetAttributeDefinition) SetType

SetType sets the Type field's value.

func (FacetAttributeDefinition) String

func (s FacetAttributeDefinition) String() string

String returns the string representation

func (*FacetAttributeDefinition) Validate

func (s *FacetAttributeDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.
	//
	// TargetAttributeName is a required field
	TargetAttributeName *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// TargetFacetName is a required field
	TargetFacetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (FacetAttributeReference) GoString

func (s FacetAttributeReference) GoString() string

GoString returns the string representation

func (*FacetAttributeReference) SetTargetAttributeName

func (s *FacetAttributeReference) SetTargetAttributeName(v string) *FacetAttributeReference

SetTargetAttributeName sets the TargetAttributeName field's value.

func (*FacetAttributeReference) SetTargetFacetName

func (s *FacetAttributeReference) SetTargetFacetName(v string) *FacetAttributeReference

SetTargetFacetName sets the TargetFacetName field's value.

func (FacetAttributeReference) String

func (s FacetAttributeReference) String() string

String returns the string representation

func (*FacetAttributeReference) Validate

func (s *FacetAttributeReference) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FacetAttributeUpdate

type FacetAttributeUpdate struct {

	// The action to perform when updating the attribute.
	Action *string `type:"string" enum:"UpdateActionType"`

	// The attribute to update.
	Attribute *FacetAttribute `type:"structure"`
	// contains filtered or unexported fields
}

A structure that contains information used to update an attribute.

func (FacetAttributeUpdate) GoString

func (s FacetAttributeUpdate) GoString() string

GoString returns the string representation

func (*FacetAttributeUpdate) SetAction

SetAction sets the Action field's value.

func (*FacetAttributeUpdate) SetAttribute

SetAttribute sets the Attribute field's value.

func (FacetAttributeUpdate) String

func (s FacetAttributeUpdate) String() string

String returns the string representation

func (*FacetAttributeUpdate) Validate

func (s *FacetAttributeUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAppliedSchemaVersionInput added in v1.12.43

type GetAppliedSchemaVersionInput struct {

	// The ARN of the applied schema.
	//
	// SchemaArn is a required field
	SchemaArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetAppliedSchemaVersionInput) GoString added in v1.12.43

func (s GetAppliedSchemaVersionInput) GoString() string

GoString returns the string representation

func (*GetAppliedSchemaVersionInput) SetSchemaArn added in v1.12.43

SetSchemaArn sets the SchemaArn field's value.

func (GetAppliedSchemaVersionInput) String added in v1.12.43

String returns the string representation

func (*GetAppliedSchemaVersionInput) Validate added in v1.12.43

func (s *GetAppliedSchemaVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAppliedSchemaVersionOutput added in v1.12.43

type GetAppliedSchemaVersionOutput struct {

	// Current applied schema ARN, including the minor version in use if one was
	// provided.
	AppliedSchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetAppliedSchemaVersionOutput) GoString added in v1.12.43

GoString returns the string representation

func (*GetAppliedSchemaVersionOutput) SetAppliedSchemaArn added in v1.12.43

SetAppliedSchemaArn sets the AppliedSchemaArn field's value.

func (GetAppliedSchemaVersionOutput) String added in v1.12.43

String returns the string representation

type GetDirectoryInput

type GetDirectoryInput struct {

	// The ARN of the directory.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetDirectoryInput) GoString

func (s GetDirectoryInput) GoString() string

GoString returns the string representation

func (*GetDirectoryInput) SetDirectoryArn

func (s *GetDirectoryInput) SetDirectoryArn(v string) *GetDirectoryInput

SetDirectoryArn sets the DirectoryArn field's value.

func (GetDirectoryInput) String

func (s GetDirectoryInput) String() string

String returns the string representation

func (*GetDirectoryInput) Validate

func (s *GetDirectoryInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetDirectoryOutput

type GetDirectoryOutput struct {

	// Metadata about the directory.
	//
	// Directory is a required field
	Directory *Directory `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetDirectoryOutput) GoString

func (s GetDirectoryOutput) GoString() string

GoString returns the string representation

func (*GetDirectoryOutput) SetDirectory

func (s *GetDirectoryOutput) SetDirectory(v *Directory) *GetDirectoryOutput

SetDirectory sets the Directory field's value.

func (GetDirectoryOutput) String

func (s GetDirectoryOutput) String() string

String returns the string representation

type GetFacetInput

type GetFacetInput struct {

	// The name of the facet to retrieve.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the Facet. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetFacetInput) GoString

func (s GetFacetInput) GoString() string

GoString returns the string representation

func (*GetFacetInput) SetName

func (s *GetFacetInput) SetName(v string) *GetFacetInput

SetName sets the Name field's value.

func (*GetFacetInput) SetSchemaArn

func (s *GetFacetInput) SetSchemaArn(v string) *GetFacetInput

SetSchemaArn sets the SchemaArn field's value.

func (GetFacetInput) String

func (s GetFacetInput) String() string

String returns the string representation

func (*GetFacetInput) Validate

func (s *GetFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetFacetOutput

type GetFacetOutput struct {

	// The Facet structure that is associated with the facet.
	Facet *Facet `type:"structure"`
	// contains filtered or unexported fields
}

func (GetFacetOutput) GoString

func (s GetFacetOutput) GoString() string

GoString returns the string representation

func (*GetFacetOutput) SetFacet

func (s *GetFacetOutput) SetFacet(v *Facet) *GetFacetOutput

SetFacet sets the Facet field's value.

func (GetFacetOutput) String

func (s GetFacetOutput) String() string

String returns the string representation

type GetLinkAttributesInput added in v1.14.4

type GetLinkAttributesInput struct {

	// A list of attribute names whose values will be retrieved.
	//
	// AttributeNames is a required field
	AttributeNames []*string `type:"list" required:"true"`

	// The consistency level at which to retrieve the attributes on a typed link.
	ConsistencyLevel *string `type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the typed link resides. For more information, see arns or Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Allows a typed link specifier to be accepted as input.
	//
	// TypedLinkSpecifier is a required field
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetLinkAttributesInput) GoString added in v1.14.4

func (s GetLinkAttributesInput) GoString() string

GoString returns the string representation

func (*GetLinkAttributesInput) SetAttributeNames added in v1.14.4

func (s *GetLinkAttributesInput) SetAttributeNames(v []*string) *GetLinkAttributesInput

SetAttributeNames sets the AttributeNames field's value.

func (*GetLinkAttributesInput) SetConsistencyLevel added in v1.14.4

func (s *GetLinkAttributesInput) SetConsistencyLevel(v string) *GetLinkAttributesInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*GetLinkAttributesInput) SetDirectoryArn added in v1.14.4

func (s *GetLinkAttributesInput) SetDirectoryArn(v string) *GetLinkAttributesInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*GetLinkAttributesInput) SetTypedLinkSpecifier added in v1.14.4

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (GetLinkAttributesInput) String added in v1.14.4

func (s GetLinkAttributesInput) String() string

String returns the string representation

func (*GetLinkAttributesInput) Validate added in v1.14.4

func (s *GetLinkAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLinkAttributesOutput added in v1.14.4

type GetLinkAttributesOutput struct {

	// The attributes that are associated with the typed link.
	Attributes []*AttributeKeyAndValue `type:"list"`
	// contains filtered or unexported fields
}

func (GetLinkAttributesOutput) GoString added in v1.14.4

func (s GetLinkAttributesOutput) GoString() string

GoString returns the string representation

func (*GetLinkAttributesOutput) SetAttributes added in v1.14.4

SetAttributes sets the Attributes field's value.

func (GetLinkAttributesOutput) String added in v1.14.4

func (s GetLinkAttributesOutput) String() string

String returns the string representation

type GetObjectAttributesInput added in v1.13.31

type GetObjectAttributesInput struct {

	// List of attribute names whose values will be retrieved.
	//
	// AttributeNames is a required field
	AttributeNames []*string `type:"list" required:"true"`

	// The consistency level at which to retrieve the attributes on an object.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Reference that identifies the object whose attributes will be retrieved.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifier for the facet whose attributes will be retrieved. See SchemaFacet
	// for details.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetObjectAttributesInput) GoString added in v1.13.31

func (s GetObjectAttributesInput) GoString() string

GoString returns the string representation

func (*GetObjectAttributesInput) SetAttributeNames added in v1.13.31

func (s *GetObjectAttributesInput) SetAttributeNames(v []*string) *GetObjectAttributesInput

SetAttributeNames sets the AttributeNames field's value.

func (*GetObjectAttributesInput) SetConsistencyLevel added in v1.13.31

func (s *GetObjectAttributesInput) SetConsistencyLevel(v string) *GetObjectAttributesInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*GetObjectAttributesInput) SetDirectoryArn added in v1.13.31

SetDirectoryArn sets the DirectoryArn field's value.

func (*GetObjectAttributesInput) SetObjectReference added in v1.13.31

SetObjectReference sets the ObjectReference field's value.

func (*GetObjectAttributesInput) SetSchemaFacet added in v1.13.31

SetSchemaFacet sets the SchemaFacet field's value.

func (GetObjectAttributesInput) String added in v1.13.31

func (s GetObjectAttributesInput) String() string

String returns the string representation

func (*GetObjectAttributesInput) Validate added in v1.13.31

func (s *GetObjectAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectAttributesOutput added in v1.13.31

type GetObjectAttributesOutput struct {

	// The attributes that are associated with the object.
	Attributes []*AttributeKeyAndValue `type:"list"`
	// contains filtered or unexported fields
}

func (GetObjectAttributesOutput) GoString added in v1.13.31

func (s GetObjectAttributesOutput) GoString() string

GoString returns the string representation

func (*GetObjectAttributesOutput) SetAttributes added in v1.13.31

SetAttributes sets the Attributes field's value.

func (GetObjectAttributesOutput) String added in v1.13.31

func (s GetObjectAttributesOutput) String() string

String returns the string representation

type GetObjectInformationInput

type GetObjectInformationInput struct {

	// The consistency level at which to retrieve the object information.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The ARN of the directory being retrieved.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A reference to the object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (GetObjectInformationInput) GoString

func (s GetObjectInformationInput) GoString() string

GoString returns the string representation

func (*GetObjectInformationInput) SetConsistencyLevel

func (s *GetObjectInformationInput) SetConsistencyLevel(v string) *GetObjectInformationInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*GetObjectInformationInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*GetObjectInformationInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (GetObjectInformationInput) String

func (s GetObjectInformationInput) String() string

String returns the string representation

func (*GetObjectInformationInput) Validate

func (s *GetObjectInformationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetObjectInformationOutput

type GetObjectInformationOutput struct {

	// The ObjectIdentifier of the specified object.
	ObjectIdentifier *string `type:"string"`

	// 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.
	SchemaFacets []*SchemaFacet `type:"list"`
	// contains filtered or unexported fields
}

func (GetObjectInformationOutput) GoString

func (s GetObjectInformationOutput) GoString() string

GoString returns the string representation

func (*GetObjectInformationOutput) SetObjectIdentifier

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (*GetObjectInformationOutput) SetSchemaFacets

SetSchemaFacets sets the SchemaFacets field's value.

func (GetObjectInformationOutput) String

String returns the string representation

type GetSchemaAsJsonInput

type GetSchemaAsJsonInput struct {

	// The ARN of the schema to retrieve.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetSchemaAsJsonInput) GoString

func (s GetSchemaAsJsonInput) GoString() string

GoString returns the string representation

func (*GetSchemaAsJsonInput) SetSchemaArn

func (s *GetSchemaAsJsonInput) SetSchemaArn(v string) *GetSchemaAsJsonInput

SetSchemaArn sets the SchemaArn field's value.

func (GetSchemaAsJsonInput) String

func (s GetSchemaAsJsonInput) String() string

String returns the string representation

func (*GetSchemaAsJsonInput) Validate

func (s *GetSchemaAsJsonInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetSchemaAsJsonOutput

type GetSchemaAsJsonOutput struct {

	// The JSON representation of the schema document.
	Document *string `type:"string"`

	// The name of the retrieved schema.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetSchemaAsJsonOutput) GoString

func (s GetSchemaAsJsonOutput) GoString() string

GoString returns the string representation

func (*GetSchemaAsJsonOutput) SetDocument

SetDocument sets the Document field's value.

func (*GetSchemaAsJsonOutput) SetName

SetName sets the Name field's value.

func (GetSchemaAsJsonOutput) String

func (s GetSchemaAsJsonOutput) String() string

String returns the string representation

type GetTypedLinkFacetInformationInput added in v1.8.31

type GetTypedLinkFacetInformationInput struct {

	// The unique name of the typed link facet.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetTypedLinkFacetInformationInput) GoString added in v1.8.31

GoString returns the string representation

func (*GetTypedLinkFacetInformationInput) SetName added in v1.8.31

SetName sets the Name field's value.

func (*GetTypedLinkFacetInformationInput) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (GetTypedLinkFacetInformationInput) String added in v1.8.31

String returns the string representation

func (*GetTypedLinkFacetInformationInput) Validate added in v1.8.31

Validate inspects the fields of the type to determine if they are valid.

type GetTypedLinkFacetInformationOutput added in v1.8.31

type GetTypedLinkFacetInformationOutput struct {

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
	IdentityAttributeOrder []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetTypedLinkFacetInformationOutput) GoString added in v1.8.31

GoString returns the string representation

func (*GetTypedLinkFacetInformationOutput) SetIdentityAttributeOrder added in v1.8.31

SetIdentityAttributeOrder sets the IdentityAttributeOrder field's value.

func (GetTypedLinkFacetInformationOutput) String added in v1.8.31

String returns the string representation

type IndexAttachment

type IndexAttachment struct {

	// The indexed attribute values.
	IndexedAttributes []*AttributeKeyAndValue `type:"list"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

Represents an index and an attached object.

func (IndexAttachment) GoString

func (s IndexAttachment) GoString() string

GoString returns the string representation

func (*IndexAttachment) SetIndexedAttributes

func (s *IndexAttachment) SetIndexedAttributes(v []*AttributeKeyAndValue) *IndexAttachment

SetIndexedAttributes sets the IndexedAttributes field's value.

func (*IndexAttachment) SetObjectIdentifier

func (s *IndexAttachment) SetObjectIdentifier(v string) *IndexAttachment

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (IndexAttachment) String

func (s IndexAttachment) String() string

String returns the string representation

type LinkAttributeAction added in v1.14.4

type LinkAttributeAction struct {

	// A type that can be either UPDATE_OR_CREATE or DELETE.
	AttributeActionType *string `type:"string" enum:"UpdateActionType"`

	// The value that you want to update to.
	AttributeUpdateValue *TypedAttributeValue `type:"structure"`
	// 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.

func (LinkAttributeAction) GoString added in v1.14.4

func (s LinkAttributeAction) GoString() string

GoString returns the string representation

func (*LinkAttributeAction) SetAttributeActionType added in v1.14.4

func (s *LinkAttributeAction) SetAttributeActionType(v string) *LinkAttributeAction

SetAttributeActionType sets the AttributeActionType field's value.

func (*LinkAttributeAction) SetAttributeUpdateValue added in v1.14.4

func (s *LinkAttributeAction) SetAttributeUpdateValue(v *TypedAttributeValue) *LinkAttributeAction

SetAttributeUpdateValue sets the AttributeUpdateValue field's value.

func (LinkAttributeAction) String added in v1.14.4

func (s LinkAttributeAction) String() string

String returns the string representation

type LinkAttributeUpdate added in v1.14.4

type LinkAttributeUpdate struct {

	// The action to perform as part of the attribute update.
	AttributeAction *LinkAttributeAction `type:"structure"`

	// The key of the attribute being updated.
	AttributeKey *AttributeKey `type:"structure"`
	// contains filtered or unexported fields
}

Structure that contains attribute update information.

func (LinkAttributeUpdate) GoString added in v1.14.4

func (s LinkAttributeUpdate) GoString() string

GoString returns the string representation

func (*LinkAttributeUpdate) SetAttributeAction added in v1.14.4

func (s *LinkAttributeUpdate) SetAttributeAction(v *LinkAttributeAction) *LinkAttributeUpdate

SetAttributeAction sets the AttributeAction field's value.

func (*LinkAttributeUpdate) SetAttributeKey added in v1.14.4

func (s *LinkAttributeUpdate) SetAttributeKey(v *AttributeKey) *LinkAttributeUpdate

SetAttributeKey sets the AttributeKey field's value.

func (LinkAttributeUpdate) String added in v1.14.4

func (s LinkAttributeUpdate) String() string

String returns the string representation

func (*LinkAttributeUpdate) Validate added in v1.14.4

func (s *LinkAttributeUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAppliedSchemaArnsInput

type ListAppliedSchemaArnsInput struct {

	// The ARN of the directory you are listing.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The response for ListAppliedSchemaArns when this parameter is used will list
	// all minor version ARNs for a major version.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAppliedSchemaArnsInput) GoString

func (s ListAppliedSchemaArnsInput) GoString() string

GoString returns the string representation

func (*ListAppliedSchemaArnsInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListAppliedSchemaArnsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAppliedSchemaArnsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListAppliedSchemaArnsInput) SetSchemaArn added in v1.12.43

SetSchemaArn sets the SchemaArn field's value.

func (ListAppliedSchemaArnsInput) String

String returns the string representation

func (*ListAppliedSchemaArnsInput) Validate

func (s *ListAppliedSchemaArnsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAppliedSchemaArnsOutput

type ListAppliedSchemaArnsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// The ARNs of schemas that are applied to the directory.
	SchemaArns []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListAppliedSchemaArnsOutput) GoString

func (s ListAppliedSchemaArnsOutput) GoString() string

GoString returns the string representation

func (*ListAppliedSchemaArnsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListAppliedSchemaArnsOutput) SetSchemaArns

SetSchemaArns sets the SchemaArns field's value.

func (ListAppliedSchemaArnsOutput) String

String returns the string representation

type ListAttachedIndicesInput

type ListAttachedIndicesInput struct {

	// The consistency level to use for this operation.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The ARN of the directory.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// A reference to the object that has indices attached.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListAttachedIndicesInput) GoString

func (s ListAttachedIndicesInput) GoString() string

GoString returns the string representation

func (*ListAttachedIndicesInput) SetConsistencyLevel

func (s *ListAttachedIndicesInput) SetConsistencyLevel(v string) *ListAttachedIndicesInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListAttachedIndicesInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListAttachedIndicesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListAttachedIndicesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListAttachedIndicesInput) SetTargetReference

SetTargetReference sets the TargetReference field's value.

func (ListAttachedIndicesInput) String

func (s ListAttachedIndicesInput) String() string

String returns the string representation

func (*ListAttachedIndicesInput) Validate

func (s *ListAttachedIndicesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAttachedIndicesOutput

type ListAttachedIndicesOutput struct {

	// The indices attached to the specified object.
	IndexAttachments []*IndexAttachment `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListAttachedIndicesOutput) GoString

func (s ListAttachedIndicesOutput) GoString() string

GoString returns the string representation

func (*ListAttachedIndicesOutput) SetIndexAttachments

SetIndexAttachments sets the IndexAttachments field's value.

func (*ListAttachedIndicesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListAttachedIndicesOutput) String

func (s ListAttachedIndicesOutput) String() string

String returns the string representation

type ListDevelopmentSchemaArnsInput

type ListDevelopmentSchemaArnsInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDevelopmentSchemaArnsInput) GoString

GoString returns the string representation

func (*ListDevelopmentSchemaArnsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListDevelopmentSchemaArnsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDevelopmentSchemaArnsInput) String

String returns the string representation

func (*ListDevelopmentSchemaArnsInput) Validate added in v1.7.7

func (s *ListDevelopmentSchemaArnsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDevelopmentSchemaArnsOutput

type ListDevelopmentSchemaArnsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// The ARNs of retrieved development schemas.
	SchemaArns []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListDevelopmentSchemaArnsOutput) GoString

GoString returns the string representation

func (*ListDevelopmentSchemaArnsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListDevelopmentSchemaArnsOutput) SetSchemaArns

SetSchemaArns sets the SchemaArns field's value.

func (ListDevelopmentSchemaArnsOutput) String

String returns the string representation

type ListDirectoriesInput

type ListDirectoriesInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The state of the directories in the list. Can be either Enabled, Disabled,
	// or Deleted.
	State *string `locationName:"state" type:"string" enum:"DirectoryState"`
	// contains filtered or unexported fields
}

func (ListDirectoriesInput) GoString

func (s ListDirectoriesInput) GoString() string

GoString returns the string representation

func (*ListDirectoriesInput) SetMaxResults

func (s *ListDirectoriesInput) SetMaxResults(v int64) *ListDirectoriesInput

SetMaxResults sets the MaxResults field's value.

func (*ListDirectoriesInput) SetNextToken

func (s *ListDirectoriesInput) SetNextToken(v string) *ListDirectoriesInput

SetNextToken sets the NextToken field's value.

func (*ListDirectoriesInput) SetState

SetState sets the State field's value.

func (ListDirectoriesInput) String

func (s ListDirectoriesInput) String() string

String returns the string representation

func (*ListDirectoriesInput) Validate added in v1.7.7

func (s *ListDirectoriesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListDirectoriesOutput

type ListDirectoriesOutput struct {

	// Lists all directories that are associated with your account in pagination
	// fashion.
	//
	// Directories is a required field
	Directories []*Directory `type:"list" required:"true"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListDirectoriesOutput) GoString

func (s ListDirectoriesOutput) GoString() string

GoString returns the string representation

func (*ListDirectoriesOutput) SetDirectories

func (s *ListDirectoriesOutput) SetDirectories(v []*Directory) *ListDirectoriesOutput

SetDirectories sets the Directories field's value.

func (*ListDirectoriesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListDirectoriesOutput) String

func (s ListDirectoriesOutput) String() string

String returns the string representation

type ListFacetAttributesInput

type ListFacetAttributesInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The name of the facet whose attributes will be retrieved.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The ARN of the schema where the facet resides.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListFacetAttributesInput) GoString

func (s ListFacetAttributesInput) GoString() string

GoString returns the string representation

func (*ListFacetAttributesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListFacetAttributesInput) SetName

SetName sets the Name field's value.

func (*ListFacetAttributesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListFacetAttributesInput) SetSchemaArn

SetSchemaArn sets the SchemaArn field's value.

func (ListFacetAttributesInput) String

func (s ListFacetAttributesInput) String() string

String returns the string representation

func (*ListFacetAttributesInput) Validate

func (s *ListFacetAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFacetAttributesOutput

type ListFacetAttributesOutput struct {

	// The attributes attached to the facet.
	Attributes []*FacetAttribute `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFacetAttributesOutput) GoString

func (s ListFacetAttributesOutput) GoString() string

GoString returns the string representation

func (*ListFacetAttributesOutput) SetAttributes

SetAttributes sets the Attributes field's value.

func (*ListFacetAttributesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFacetAttributesOutput) String

func (s ListFacetAttributesOutput) String() string

String returns the string representation

type ListFacetNamesInput

type ListFacetNamesInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) to retrieve facet names from.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListFacetNamesInput) GoString

func (s ListFacetNamesInput) GoString() string

GoString returns the string representation

func (*ListFacetNamesInput) SetMaxResults

func (s *ListFacetNamesInput) SetMaxResults(v int64) *ListFacetNamesInput

SetMaxResults sets the MaxResults field's value.

func (*ListFacetNamesInput) SetNextToken

func (s *ListFacetNamesInput) SetNextToken(v string) *ListFacetNamesInput

SetNextToken sets the NextToken field's value.

func (*ListFacetNamesInput) SetSchemaArn

func (s *ListFacetNamesInput) SetSchemaArn(v string) *ListFacetNamesInput

SetSchemaArn sets the SchemaArn field's value.

func (ListFacetNamesInput) String

func (s ListFacetNamesInput) String() string

String returns the string representation

func (*ListFacetNamesInput) Validate

func (s *ListFacetNamesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFacetNamesOutput

type ListFacetNamesOutput struct {

	// The names of facets that exist within the schema.
	FacetNames []*string `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFacetNamesOutput) GoString

func (s ListFacetNamesOutput) GoString() string

GoString returns the string representation

func (*ListFacetNamesOutput) SetFacetNames

func (s *ListFacetNamesOutput) SetFacetNames(v []*string) *ListFacetNamesOutput

SetFacetNames sets the FacetNames field's value.

func (*ListFacetNamesOutput) SetNextToken

func (s *ListFacetNamesOutput) SetNextToken(v string) *ListFacetNamesOutput

SetNextToken sets the NextToken field's value.

func (ListFacetNamesOutput) String

func (s ListFacetNamesOutput) String() string

String returns the string representation

type ListIncomingTypedLinksInput added in v1.8.31

type ListIncomingTypedLinksInput struct {

	// The consistency level to execute the request at.
	ConsistencyLevel *string `type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) of the directory where you want to list the
	// typed links.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// 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 `type:"list"`

	// 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 `type:"structure"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListIncomingTypedLinksInput) GoString added in v1.8.31

func (s ListIncomingTypedLinksInput) GoString() string

GoString returns the string representation

func (*ListIncomingTypedLinksInput) SetConsistencyLevel added in v1.8.31

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListIncomingTypedLinksInput) SetDirectoryArn added in v1.8.31

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListIncomingTypedLinksInput) SetFilterAttributeRanges added in v1.8.31

SetFilterAttributeRanges sets the FilterAttributeRanges field's value.

SetFilterTypedLink sets the FilterTypedLink field's value.

func (*ListIncomingTypedLinksInput) SetMaxResults added in v1.8.31

SetMaxResults sets the MaxResults field's value.

func (*ListIncomingTypedLinksInput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (*ListIncomingTypedLinksInput) SetObjectReference added in v1.8.31

SetObjectReference sets the ObjectReference field's value.

func (ListIncomingTypedLinksInput) String added in v1.8.31

String returns the string representation

func (*ListIncomingTypedLinksInput) Validate added in v1.8.31

func (s *ListIncomingTypedLinksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIncomingTypedLinksOutput added in v1.8.31

type ListIncomingTypedLinksOutput struct {

	// Returns one or more typed link specifiers as output.
	LinkSpecifiers []*TypedLinkSpecifier `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListIncomingTypedLinksOutput) GoString added in v1.8.31

func (s ListIncomingTypedLinksOutput) GoString() string

GoString returns the string representation

func (*ListIncomingTypedLinksOutput) SetLinkSpecifiers added in v1.8.31

SetLinkSpecifiers sets the LinkSpecifiers field's value.

func (*ListIncomingTypedLinksOutput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (ListIncomingTypedLinksOutput) String added in v1.8.31

String returns the string representation

type ListIndexInput

type ListIndexInput struct {

	// The consistency level to execute the request at.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The ARN of the directory that the index exists in.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The reference to the index to list.
	//
	// IndexReference is a required field
	IndexReference *ObjectReference `type:"structure" required:"true"`

	// 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
	// (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html).
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Specifies the ranges of indexed values that you want to query.
	RangesOnIndexedValues []*ObjectAttributeRange `type:"list"`
	// contains filtered or unexported fields
}

func (ListIndexInput) GoString

func (s ListIndexInput) GoString() string

GoString returns the string representation

func (*ListIndexInput) SetConsistencyLevel

func (s *ListIndexInput) SetConsistencyLevel(v string) *ListIndexInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListIndexInput) SetDirectoryArn

func (s *ListIndexInput) SetDirectoryArn(v string) *ListIndexInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListIndexInput) SetIndexReference

func (s *ListIndexInput) SetIndexReference(v *ObjectReference) *ListIndexInput

SetIndexReference sets the IndexReference field's value.

func (*ListIndexInput) SetMaxResults

func (s *ListIndexInput) SetMaxResults(v int64) *ListIndexInput

SetMaxResults sets the MaxResults field's value.

func (*ListIndexInput) SetNextToken

func (s *ListIndexInput) SetNextToken(v string) *ListIndexInput

SetNextToken sets the NextToken field's value.

func (*ListIndexInput) SetRangesOnIndexedValues

func (s *ListIndexInput) SetRangesOnIndexedValues(v []*ObjectAttributeRange) *ListIndexInput

SetRangesOnIndexedValues sets the RangesOnIndexedValues field's value.

func (ListIndexInput) String

func (s ListIndexInput) String() string

String returns the string representation

func (*ListIndexInput) Validate

func (s *ListIndexInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListIndexOutput

type ListIndexOutput struct {

	// The objects and indexed values attached to the index.
	IndexAttachments []*IndexAttachment `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListIndexOutput) GoString

func (s ListIndexOutput) GoString() string

GoString returns the string representation

func (*ListIndexOutput) SetIndexAttachments

func (s *ListIndexOutput) SetIndexAttachments(v []*IndexAttachment) *ListIndexOutput

SetIndexAttachments sets the IndexAttachments field's value.

func (*ListIndexOutput) SetNextToken

func (s *ListIndexOutput) SetNextToken(v string) *ListIndexOutput

SetNextToken sets the NextToken field's value.

func (ListIndexOutput) String

func (s ListIndexOutput) String() string

String returns the string representation

type ListManagedSchemaArnsInput added in v1.14.12

type ListManagedSchemaArnsInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The response for ListManagedSchemaArns. When this parameter is used, all
	// minor version ARNs for a major version are listed.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListManagedSchemaArnsInput) GoString added in v1.14.12

func (s ListManagedSchemaArnsInput) GoString() string

GoString returns the string representation

func (*ListManagedSchemaArnsInput) SetMaxResults added in v1.14.12

SetMaxResults sets the MaxResults field's value.

func (*ListManagedSchemaArnsInput) SetNextToken added in v1.14.12

SetNextToken sets the NextToken field's value.

func (*ListManagedSchemaArnsInput) SetSchemaArn added in v1.14.12

SetSchemaArn sets the SchemaArn field's value.

func (ListManagedSchemaArnsInput) String added in v1.14.12

String returns the string representation

func (*ListManagedSchemaArnsInput) Validate added in v1.14.12

func (s *ListManagedSchemaArnsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListManagedSchemaArnsOutput added in v1.14.12

type ListManagedSchemaArnsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// The ARNs for all AWS managed schemas.
	SchemaArns []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListManagedSchemaArnsOutput) GoString added in v1.14.12

func (s ListManagedSchemaArnsOutput) GoString() string

GoString returns the string representation

func (*ListManagedSchemaArnsOutput) SetNextToken added in v1.14.12

SetNextToken sets the NextToken field's value.

func (*ListManagedSchemaArnsOutput) SetSchemaArns added in v1.14.12

SetSchemaArns sets the SchemaArns field's value.

func (ListManagedSchemaArnsOutput) String added in v1.14.12

String returns the string representation

type ListObjectAttributesInput

type ListObjectAttributesInput struct {

	// 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.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

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

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectAttributesInput) GoString

func (s ListObjectAttributesInput) GoString() string

GoString returns the string representation

func (*ListObjectAttributesInput) SetConsistencyLevel

func (s *ListObjectAttributesInput) SetConsistencyLevel(v string) *ListObjectAttributesInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListObjectAttributesInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListObjectAttributesInput) SetFacetFilter added in v1.8.6

SetFacetFilter sets the FacetFilter field's value.

func (*ListObjectAttributesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListObjectAttributesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListObjectAttributesInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (ListObjectAttributesInput) String

func (s ListObjectAttributesInput) String() string

String returns the string representation

func (*ListObjectAttributesInput) Validate

func (s *ListObjectAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectAttributesOutput

type ListObjectAttributesOutput struct {

	// Attributes map that is associated with the object. AttributeArn is the key,
	// and attribute value is the value.
	Attributes []*AttributeKeyAndValue `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectAttributesOutput) GoString

func (s ListObjectAttributesOutput) GoString() string

GoString returns the string representation

func (*ListObjectAttributesOutput) SetAttributes

SetAttributes sets the Attributes field's value.

func (*ListObjectAttributesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListObjectAttributesOutput) String

String returns the string representation

type ListObjectChildrenInput

type ListObjectChildrenInput struct {

	// 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.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object for which child objects are being
	// listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectChildrenInput) GoString

func (s ListObjectChildrenInput) GoString() string

GoString returns the string representation

func (*ListObjectChildrenInput) SetConsistencyLevel

func (s *ListObjectChildrenInput) SetConsistencyLevel(v string) *ListObjectChildrenInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListObjectChildrenInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListObjectChildrenInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListObjectChildrenInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListObjectChildrenInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (ListObjectChildrenInput) String

func (s ListObjectChildrenInput) String() string

String returns the string representation

func (*ListObjectChildrenInput) Validate

func (s *ListObjectChildrenInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectChildrenOutput

type ListObjectChildrenOutput struct {

	// Children structure, which is a map with key as the LinkName and ObjectIdentifier
	// as the value.
	Children map[string]*string `type:"map"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectChildrenOutput) GoString

func (s ListObjectChildrenOutput) GoString() string

GoString returns the string representation

func (*ListObjectChildrenOutput) SetChildren

SetChildren sets the Children field's value.

func (*ListObjectChildrenOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListObjectChildrenOutput) String

func (s ListObjectChildrenOutput) String() string

String returns the string representation

type ListObjectParentPathsInput added in v1.7.7

type ListObjectParentPathsInput struct {

	// The ARN of the directory to which the parent path applies.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object whose parent paths are listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectParentPathsInput) GoString added in v1.7.7

func (s ListObjectParentPathsInput) GoString() string

GoString returns the string representation

func (*ListObjectParentPathsInput) SetDirectoryArn added in v1.7.7

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListObjectParentPathsInput) SetMaxResults added in v1.7.7

SetMaxResults sets the MaxResults field's value.

func (*ListObjectParentPathsInput) SetNextToken added in v1.7.7

SetNextToken sets the NextToken field's value.

func (*ListObjectParentPathsInput) SetObjectReference added in v1.7.7

SetObjectReference sets the ObjectReference field's value.

func (ListObjectParentPathsInput) String added in v1.7.7

String returns the string representation

func (*ListObjectParentPathsInput) Validate added in v1.7.7

func (s *ListObjectParentPathsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectParentPathsOutput added in v1.7.7

type ListObjectParentPathsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// Returns the path to the ObjectIdentifiers that are associated with the directory.
	PathToObjectIdentifiersList []*PathToObjectIdentifiers `type:"list"`
	// contains filtered or unexported fields
}

func (ListObjectParentPathsOutput) GoString added in v1.7.7

func (s ListObjectParentPathsOutput) GoString() string

GoString returns the string representation

func (*ListObjectParentPathsOutput) SetNextToken added in v1.7.7

SetNextToken sets the NextToken field's value.

func (*ListObjectParentPathsOutput) SetPathToObjectIdentifiersList added in v1.7.7

func (s *ListObjectParentPathsOutput) SetPathToObjectIdentifiersList(v []*PathToObjectIdentifiers) *ListObjectParentPathsOutput

SetPathToObjectIdentifiersList sets the PathToObjectIdentifiersList field's value.

func (ListObjectParentPathsOutput) String added in v1.7.7

String returns the string representation

type ListObjectParentsInput

type ListObjectParentsInput struct {

	// 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.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// When set to True, returns all ListObjectParentsResponse$ParentLinks. There
	// could be multiple links between a parent-child pair.
	IncludeAllLinksToEachParent *bool `type:"boolean"`

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the object for which parent objects are being
	// listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectParentsInput) GoString

func (s ListObjectParentsInput) GoString() string

GoString returns the string representation

func (*ListObjectParentsInput) SetConsistencyLevel

func (s *ListObjectParentsInput) SetConsistencyLevel(v string) *ListObjectParentsInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListObjectParentsInput) SetDirectoryArn

func (s *ListObjectParentsInput) SetDirectoryArn(v string) *ListObjectParentsInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListObjectParentsInput) SetIncludeAllLinksToEachParent added in v1.15.68

func (s *ListObjectParentsInput) SetIncludeAllLinksToEachParent(v bool) *ListObjectParentsInput

SetIncludeAllLinksToEachParent sets the IncludeAllLinksToEachParent field's value.

func (*ListObjectParentsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListObjectParentsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListObjectParentsInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (ListObjectParentsInput) String

func (s ListObjectParentsInput) String() string

String returns the string representation

func (*ListObjectParentsInput) Validate

func (s *ListObjectParentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectParentsOutput

type ListObjectParentsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// Returns a list of parent reference and LinkName Tuples.
	ParentLinks []*ObjectIdentifierAndLinkNameTuple `type:"list"`

	// The parent structure, which is a map with key as the ObjectIdentifier and
	// LinkName as the value.
	Parents map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (ListObjectParentsOutput) GoString

func (s ListObjectParentsOutput) GoString() string

GoString returns the string representation

func (*ListObjectParentsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

SetParentLinks sets the ParentLinks field's value.

func (*ListObjectParentsOutput) SetParents

SetParents sets the Parents field's value.

func (ListObjectParentsOutput) String

func (s ListObjectParentsOutput) String() string

String returns the string representation

type ListObjectPoliciesInput

type ListObjectPoliciesInput struct {

	// 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.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// objects reside. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// Reference that identifies the object for which policies will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListObjectPoliciesInput) GoString

func (s ListObjectPoliciesInput) GoString() string

GoString returns the string representation

func (*ListObjectPoliciesInput) SetConsistencyLevel

func (s *ListObjectPoliciesInput) SetConsistencyLevel(v string) *ListObjectPoliciesInput

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListObjectPoliciesInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListObjectPoliciesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListObjectPoliciesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListObjectPoliciesInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (ListObjectPoliciesInput) String

func (s ListObjectPoliciesInput) String() string

String returns the string representation

func (*ListObjectPoliciesInput) Validate

func (s *ListObjectPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListObjectPoliciesOutput

type ListObjectPoliciesOutput struct {

	// A list of policy ObjectIdentifiers, that are attached to the object.
	AttachedPolicyIds []*string `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListObjectPoliciesOutput) GoString

func (s ListObjectPoliciesOutput) GoString() string

GoString returns the string representation

func (*ListObjectPoliciesOutput) SetAttachedPolicyIds

func (s *ListObjectPoliciesOutput) SetAttachedPolicyIds(v []*string) *ListObjectPoliciesOutput

SetAttachedPolicyIds sets the AttachedPolicyIds field's value.

func (*ListObjectPoliciesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListObjectPoliciesOutput) String

func (s ListObjectPoliciesOutput) String() string

String returns the string representation

type ListOutgoingTypedLinksInput added in v1.8.31

type ListOutgoingTypedLinksInput struct {

	// The consistency level to execute the request at.
	ConsistencyLevel *string `type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) of the directory where you want to list the
	// typed links.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// 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 `type:"list"`

	// 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 `type:"structure"`

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// A reference that identifies the object whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListOutgoingTypedLinksInput) GoString added in v1.8.31

func (s ListOutgoingTypedLinksInput) GoString() string

GoString returns the string representation

func (*ListOutgoingTypedLinksInput) SetConsistencyLevel added in v1.8.31

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListOutgoingTypedLinksInput) SetDirectoryArn added in v1.8.31

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListOutgoingTypedLinksInput) SetFilterAttributeRanges added in v1.8.31

SetFilterAttributeRanges sets the FilterAttributeRanges field's value.

SetFilterTypedLink sets the FilterTypedLink field's value.

func (*ListOutgoingTypedLinksInput) SetMaxResults added in v1.8.31

SetMaxResults sets the MaxResults field's value.

func (*ListOutgoingTypedLinksInput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (*ListOutgoingTypedLinksInput) SetObjectReference added in v1.8.31

SetObjectReference sets the ObjectReference field's value.

func (ListOutgoingTypedLinksInput) String added in v1.8.31

String returns the string representation

func (*ListOutgoingTypedLinksInput) Validate added in v1.8.31

func (s *ListOutgoingTypedLinksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListOutgoingTypedLinksOutput added in v1.8.31

type ListOutgoingTypedLinksOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// Returns a typed link specifier as output.
	TypedLinkSpecifiers []*TypedLinkSpecifier `type:"list"`
	// contains filtered or unexported fields
}

func (ListOutgoingTypedLinksOutput) GoString added in v1.8.31

func (s ListOutgoingTypedLinksOutput) GoString() string

GoString returns the string representation

func (*ListOutgoingTypedLinksOutput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (*ListOutgoingTypedLinksOutput) SetTypedLinkSpecifiers added in v1.8.31

SetTypedLinkSpecifiers sets the TypedLinkSpecifiers field's value.

func (ListOutgoingTypedLinksOutput) String added in v1.8.31

String returns the string representation

type ListPolicyAttachmentsInput

type ListPolicyAttachmentsInput struct {

	// 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.
	ConsistencyLevel *string `location:"header" locationName:"x-amz-consistency-level" type:"string" enum:"ConsistencyLevel"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// objects reside. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The reference that identifies the policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (ListPolicyAttachmentsInput) GoString

func (s ListPolicyAttachmentsInput) GoString() string

GoString returns the string representation

func (*ListPolicyAttachmentsInput) SetConsistencyLevel

SetConsistencyLevel sets the ConsistencyLevel field's value.

func (*ListPolicyAttachmentsInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*ListPolicyAttachmentsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListPolicyAttachmentsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPolicyAttachmentsInput) SetPolicyReference

SetPolicyReference sets the PolicyReference field's value.

func (ListPolicyAttachmentsInput) String

String returns the string representation

func (*ListPolicyAttachmentsInput) Validate

func (s *ListPolicyAttachmentsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPolicyAttachmentsOutput

type ListPolicyAttachmentsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

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

func (ListPolicyAttachmentsOutput) GoString

func (s ListPolicyAttachmentsOutput) GoString() string

GoString returns the string representation

func (*ListPolicyAttachmentsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPolicyAttachmentsOutput) SetObjectIdentifiers

func (s *ListPolicyAttachmentsOutput) SetObjectIdentifiers(v []*string) *ListPolicyAttachmentsOutput

SetObjectIdentifiers sets the ObjectIdentifiers field's value.

func (ListPolicyAttachmentsOutput) String

String returns the string representation

type ListPublishedSchemaArnsInput

type ListPublishedSchemaArnsInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The response for ListPublishedSchemaArns when this parameter is used will
	// list all minor version ARNs for a major version.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListPublishedSchemaArnsInput) GoString

func (s ListPublishedSchemaArnsInput) GoString() string

GoString returns the string representation

func (*ListPublishedSchemaArnsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListPublishedSchemaArnsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPublishedSchemaArnsInput) SetSchemaArn added in v1.12.43

SetSchemaArn sets the SchemaArn field's value.

func (ListPublishedSchemaArnsInput) String

String returns the string representation

func (*ListPublishedSchemaArnsInput) Validate added in v1.7.7

func (s *ListPublishedSchemaArnsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListPublishedSchemaArnsOutput

type ListPublishedSchemaArnsOutput struct {

	// The pagination token.
	NextToken *string `type:"string"`

	// The ARNs of published schemas.
	SchemaArns []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListPublishedSchemaArnsOutput) GoString

GoString returns the string representation

func (*ListPublishedSchemaArnsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListPublishedSchemaArnsOutput) SetSchemaArns

SetSchemaArns sets the SchemaArns field's value.

func (ListPublishedSchemaArnsOutput) String

String returns the string representation

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The MaxResults parameter sets the maximum number of results returned in a
	// single page. This is for future use and is not supported currently.
	MaxResults *int64 `min:"50" type:"integer"`

	// The pagination token. This is for future use. Currently pagination is not
	// supported for tagging.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) of the resource. Tagging is only supported
	// for directories.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// The token to use to retrieve the next page of results. This value is null
	// when there are no more results to return.
	NextToken *string `type:"string"`

	// A list of tag key value pairs that are associated with the response.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTypedLinkFacetAttributesInput added in v1.8.31

type ListTypedLinkFacetAttributesInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The unique name of the typed link facet.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTypedLinkFacetAttributesInput) GoString added in v1.8.31

GoString returns the string representation

func (*ListTypedLinkFacetAttributesInput) SetMaxResults added in v1.8.31

SetMaxResults sets the MaxResults field's value.

func (*ListTypedLinkFacetAttributesInput) SetName added in v1.8.31

SetName sets the Name field's value.

func (*ListTypedLinkFacetAttributesInput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (*ListTypedLinkFacetAttributesInput) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (ListTypedLinkFacetAttributesInput) String added in v1.8.31

String returns the string representation

func (*ListTypedLinkFacetAttributesInput) Validate added in v1.8.31

Validate inspects the fields of the type to determine if they are valid.

type ListTypedLinkFacetAttributesOutput added in v1.8.31

type ListTypedLinkFacetAttributesOutput struct {

	// An ordered set of attributes associate with the typed link.
	Attributes []*TypedLinkAttributeDefinition `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTypedLinkFacetAttributesOutput) GoString added in v1.8.31

GoString returns the string representation

func (*ListTypedLinkFacetAttributesOutput) SetAttributes added in v1.8.31

SetAttributes sets the Attributes field's value.

func (*ListTypedLinkFacetAttributesOutput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (ListTypedLinkFacetAttributesOutput) String added in v1.8.31

String returns the string representation

type ListTypedLinkFacetNamesInput added in v1.8.31

type ListTypedLinkFacetNamesInput struct {

	// The maximum number of results to retrieve.
	MaxResults *int64 `min:"1" type:"integer"`

	// The pagination token.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTypedLinkFacetNamesInput) GoString added in v1.8.31

func (s ListTypedLinkFacetNamesInput) GoString() string

GoString returns the string representation

func (*ListTypedLinkFacetNamesInput) SetMaxResults added in v1.8.31

SetMaxResults sets the MaxResults field's value.

func (*ListTypedLinkFacetNamesInput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (*ListTypedLinkFacetNamesInput) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (ListTypedLinkFacetNamesInput) String added in v1.8.31

String returns the string representation

func (*ListTypedLinkFacetNamesInput) Validate added in v1.8.31

func (s *ListTypedLinkFacetNamesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTypedLinkFacetNamesOutput added in v1.8.31

type ListTypedLinkFacetNamesOutput struct {

	// The names of typed link facets that exist within the schema.
	FacetNames []*string `type:"list"`

	// The pagination token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListTypedLinkFacetNamesOutput) GoString added in v1.8.31

GoString returns the string representation

func (*ListTypedLinkFacetNamesOutput) SetFacetNames added in v1.8.31

SetFacetNames sets the FacetNames field's value.

func (*ListTypedLinkFacetNamesOutput) SetNextToken added in v1.8.31

SetNextToken sets the NextToken field's value.

func (ListTypedLinkFacetNamesOutput) String added in v1.8.31

String returns the string representation

type LookupPolicyInput

type LookupPolicyInput struct {

	// The Amazon Resource Name (ARN) that is associated with the Directory. For
	// more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to request the next page of results.
	NextToken *string `type:"string"`

	// Reference that identifies the object whose policies will be looked up.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (LookupPolicyInput) GoString

func (s LookupPolicyInput) GoString() string

GoString returns the string representation

func (*LookupPolicyInput) SetDirectoryArn

func (s *LookupPolicyInput) SetDirectoryArn(v string) *LookupPolicyInput

SetDirectoryArn sets the DirectoryArn field's value.

func (*LookupPolicyInput) SetMaxResults

func (s *LookupPolicyInput) SetMaxResults(v int64) *LookupPolicyInput

SetMaxResults sets the MaxResults field's value.

func (*LookupPolicyInput) SetNextToken

func (s *LookupPolicyInput) SetNextToken(v string) *LookupPolicyInput

SetNextToken sets the NextToken field's value.

func (*LookupPolicyInput) SetObjectReference

func (s *LookupPolicyInput) SetObjectReference(v *ObjectReference) *LookupPolicyInput

SetObjectReference sets the ObjectReference field's value.

func (LookupPolicyInput) String

func (s LookupPolicyInput) String() string

String returns the string representation

func (*LookupPolicyInput) Validate

func (s *LookupPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LookupPolicyOutput

type LookupPolicyOutput struct {

	// The pagination token.
	NextToken *string `type:"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 `type:"list"`
	// contains filtered or unexported fields
}

func (LookupPolicyOutput) GoString

func (s LookupPolicyOutput) GoString() string

GoString returns the string representation

func (*LookupPolicyOutput) SetNextToken

func (s *LookupPolicyOutput) SetNextToken(v string) *LookupPolicyOutput

SetNextToken sets the NextToken field's value.

func (*LookupPolicyOutput) SetPolicyToPathList

func (s *LookupPolicyOutput) SetPolicyToPathList(v []*PolicyToPath) *LookupPolicyOutput

SetPolicyToPathList sets the PolicyToPathList field's value.

func (LookupPolicyOutput) String

func (s LookupPolicyOutput) String() string

String returns the string representation

type ObjectAttributeAction

type ObjectAttributeAction struct {

	// A type that can be either Update or Delete.
	ObjectAttributeActionType *string `type:"string" enum:"UpdateActionType"`

	// The value that you want to update to.
	ObjectAttributeUpdateValue *TypedAttributeValue `type:"structure"`
	// contains filtered or unexported fields
}

The action to take on the object attribute.

func (ObjectAttributeAction) GoString

func (s ObjectAttributeAction) GoString() string

GoString returns the string representation

func (*ObjectAttributeAction) SetObjectAttributeActionType

func (s *ObjectAttributeAction) SetObjectAttributeActionType(v string) *ObjectAttributeAction

SetObjectAttributeActionType sets the ObjectAttributeActionType field's value.

func (*ObjectAttributeAction) SetObjectAttributeUpdateValue

func (s *ObjectAttributeAction) SetObjectAttributeUpdateValue(v *TypedAttributeValue) *ObjectAttributeAction

SetObjectAttributeUpdateValue sets the ObjectAttributeUpdateValue field's value.

func (ObjectAttributeAction) String

func (s ObjectAttributeAction) String() string

String returns the string representation

type ObjectAttributeRange

type ObjectAttributeRange struct {

	// The key of the attribute that the attribute range covers.
	AttributeKey *AttributeKey `type:"structure"`

	// The range of attribute values being selected.
	Range *TypedAttributeValueRange `type:"structure"`
	// contains filtered or unexported fields
}

A range of attributes.

func (ObjectAttributeRange) GoString

func (s ObjectAttributeRange) GoString() string

GoString returns the string representation

func (*ObjectAttributeRange) SetAttributeKey

func (s *ObjectAttributeRange) SetAttributeKey(v *AttributeKey) *ObjectAttributeRange

SetAttributeKey sets the AttributeKey field's value.

func (*ObjectAttributeRange) SetRange

SetRange sets the Range field's value.

func (ObjectAttributeRange) String

func (s ObjectAttributeRange) String() string

String returns the string representation

func (*ObjectAttributeRange) Validate

func (s *ObjectAttributeRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ObjectAttributeUpdate

type ObjectAttributeUpdate struct {

	// The action to perform as part of the attribute update.
	ObjectAttributeAction *ObjectAttributeAction `type:"structure"`

	// The key of the attribute being updated.
	ObjectAttributeKey *AttributeKey `type:"structure"`
	// contains filtered or unexported fields
}

Structure that contains attribute update information.

func (ObjectAttributeUpdate) GoString

func (s ObjectAttributeUpdate) GoString() string

GoString returns the string representation

func (*ObjectAttributeUpdate) SetObjectAttributeAction

func (s *ObjectAttributeUpdate) SetObjectAttributeAction(v *ObjectAttributeAction) *ObjectAttributeUpdate

SetObjectAttributeAction sets the ObjectAttributeAction field's value.

func (*ObjectAttributeUpdate) SetObjectAttributeKey

func (s *ObjectAttributeUpdate) SetObjectAttributeKey(v *AttributeKey) *ObjectAttributeUpdate

SetObjectAttributeKey sets the ObjectAttributeKey field's value.

func (ObjectAttributeUpdate) String

func (s ObjectAttributeUpdate) String() string

String returns the string representation

func (*ObjectAttributeUpdate) Validate

func (s *ObjectAttributeUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ObjectIdentifierAndLinkNameTuple added in v1.15.68

type ObjectIdentifierAndLinkNameTuple struct {

	// The name of the link between the parent and the child object.
	LinkName *string `min:"1" type:"string"`

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

A pair of ObjectIdentifier and LinkName.

func (ObjectIdentifierAndLinkNameTuple) GoString added in v1.15.68

GoString returns the string representation

func (*ObjectIdentifierAndLinkNameTuple) SetLinkName added in v1.15.68

SetLinkName sets the LinkName field's value.

func (*ObjectIdentifierAndLinkNameTuple) SetObjectIdentifier added in v1.15.68

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (ObjectIdentifierAndLinkNameTuple) String added in v1.15.68

String returns the string representation

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
	//
	//    * /some/path - Identifies the object based on path
	//
	//    * #SomeBatchReference - Identifies the object in a batch call
	Selector *string `type:"string"`
	// contains filtered or unexported fields
}

The reference that identifies an object.

func (ObjectReference) GoString

func (s ObjectReference) GoString() string

GoString returns the string representation

func (*ObjectReference) SetSelector

func (s *ObjectReference) SetSelector(v string) *ObjectReference

SetSelector sets the Selector field's value.

func (ObjectReference) String

func (s ObjectReference) String() string

String returns the string representation

type PathToObjectIdentifiers added in v1.7.7

type PathToObjectIdentifiers struct {

	// Lists ObjectIdentifiers starting from directory root to the object in the
	// request.
	ObjectIdentifiers []*string `type:"list"`

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

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

func (PathToObjectIdentifiers) GoString added in v1.7.7

func (s PathToObjectIdentifiers) GoString() string

GoString returns the string representation

func (*PathToObjectIdentifiers) SetObjectIdentifiers added in v1.7.7

func (s *PathToObjectIdentifiers) SetObjectIdentifiers(v []*string) *PathToObjectIdentifiers

SetObjectIdentifiers sets the ObjectIdentifiers field's value.

func (*PathToObjectIdentifiers) SetPath added in v1.7.7

SetPath sets the Path field's value.

func (PathToObjectIdentifiers) String added in v1.7.7

func (s PathToObjectIdentifiers) String() string

String returns the string representation

type PolicyAttachment

type PolicyAttachment struct {

	// The ObjectIdentifier that is associated with PolicyAttachment.
	ObjectIdentifier *string `type:"string"`

	// The ID of PolicyAttachment.
	PolicyId *string `type:"string"`

	// The type of policy that can be associated with PolicyAttachment.
	PolicyType *string `type:"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).

func (PolicyAttachment) GoString

func (s PolicyAttachment) GoString() string

GoString returns the string representation

func (*PolicyAttachment) SetObjectIdentifier

func (s *PolicyAttachment) SetObjectIdentifier(v string) *PolicyAttachment

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (*PolicyAttachment) SetPolicyId

func (s *PolicyAttachment) SetPolicyId(v string) *PolicyAttachment

SetPolicyId sets the PolicyId field's value.

func (*PolicyAttachment) SetPolicyType

func (s *PolicyAttachment) SetPolicyType(v string) *PolicyAttachment

SetPolicyType sets the PolicyType field's value.

func (PolicyAttachment) String

func (s PolicyAttachment) String() string

String returns the string representation

type PolicyToPath

type PolicyToPath struct {

	// The path that is referenced from the root.
	Path *string `type:"string"`

	// List of policy objects.
	Policies []*PolicyAttachment `type:"list"`
	// 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.

func (PolicyToPath) GoString

func (s PolicyToPath) GoString() string

GoString returns the string representation

func (*PolicyToPath) SetPath

func (s *PolicyToPath) SetPath(v string) *PolicyToPath

SetPath sets the Path field's value.

func (*PolicyToPath) SetPolicies

func (s *PolicyToPath) SetPolicies(v []*PolicyAttachment) *PolicyToPath

SetPolicies sets the Policies field's value.

func (PolicyToPath) String

func (s PolicyToPath) String() string

String returns the string representation

type PublishSchemaInput

type PublishSchemaInput struct {

	// The Amazon Resource Name (ARN) that is associated with the development schema.
	// For more information, see arns.
	//
	// DevelopmentSchemaArn is a required field
	DevelopmentSchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// 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.
	MinorVersion *string `min:"1" type:"string"`

	// The new name under which the schema will be published. If this is not provided,
	// the development schema is considered.
	Name *string `min:"1" type:"string"`

	// The major version under which the schema will be published. Schemas have
	// both a major and minor version associated with them.
	//
	// Version is a required field
	Version *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PublishSchemaInput) GoString

func (s PublishSchemaInput) GoString() string

GoString returns the string representation

func (*PublishSchemaInput) SetDevelopmentSchemaArn

func (s *PublishSchemaInput) SetDevelopmentSchemaArn(v string) *PublishSchemaInput

SetDevelopmentSchemaArn sets the DevelopmentSchemaArn field's value.

func (*PublishSchemaInput) SetMinorVersion added in v1.12.43

func (s *PublishSchemaInput) SetMinorVersion(v string) *PublishSchemaInput

SetMinorVersion sets the MinorVersion field's value.

func (*PublishSchemaInput) SetName

SetName sets the Name field's value.

func (*PublishSchemaInput) SetVersion

func (s *PublishSchemaInput) SetVersion(v string) *PublishSchemaInput

SetVersion sets the Version field's value.

func (PublishSchemaInput) String

func (s PublishSchemaInput) String() string

String returns the string representation

func (*PublishSchemaInput) Validate

func (s *PublishSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PublishSchemaOutput

type PublishSchemaOutput struct {

	// The ARN that is associated with the published schema. For more information,
	// see arns.
	PublishedSchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (PublishSchemaOutput) GoString

func (s PublishSchemaOutput) GoString() string

GoString returns the string representation

func (*PublishSchemaOutput) SetPublishedSchemaArn

func (s *PublishSchemaOutput) SetPublishedSchemaArn(v string) *PublishSchemaOutput

SetPublishedSchemaArn sets the PublishedSchemaArn field's value.

func (PublishSchemaOutput) String

func (s PublishSchemaOutput) String() string

String returns the string representation

type PutSchemaFromJsonInput

type PutSchemaFromJsonInput struct {

	// The replacement JSON schema.
	//
	// Document is a required field
	Document *string `type:"string" required:"true"`

	// The ARN of the schema to update.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutSchemaFromJsonInput) GoString

func (s PutSchemaFromJsonInput) GoString() string

GoString returns the string representation

func (*PutSchemaFromJsonInput) SetDocument

SetDocument sets the Document field's value.

func (*PutSchemaFromJsonInput) SetSchemaArn

SetSchemaArn sets the SchemaArn field's value.

func (PutSchemaFromJsonInput) String

func (s PutSchemaFromJsonInput) String() string

String returns the string representation

func (*PutSchemaFromJsonInput) Validate

func (s *PutSchemaFromJsonInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutSchemaFromJsonOutput

type PutSchemaFromJsonOutput struct {

	// The ARN of the schema to update.
	Arn *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutSchemaFromJsonOutput) GoString

func (s PutSchemaFromJsonOutput) GoString() string

GoString returns the string representation

func (*PutSchemaFromJsonOutput) SetArn

SetArn sets the Arn field's value.

func (PutSchemaFromJsonOutput) String

func (s PutSchemaFromJsonOutput) String() string

String returns the string representation

type RemoveFacetFromObjectInput

type RemoveFacetFromObjectInput struct {

	// The ARN of the directory in which the object resides.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// A reference to the object to remove the facet from.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`

	// The facet to remove. See SchemaFacet for details.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveFacetFromObjectInput) GoString

func (s RemoveFacetFromObjectInput) GoString() string

GoString returns the string representation

func (*RemoveFacetFromObjectInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*RemoveFacetFromObjectInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (*RemoveFacetFromObjectInput) SetSchemaFacet

SetSchemaFacet sets the SchemaFacet field's value.

func (RemoveFacetFromObjectInput) String

String returns the string representation

func (*RemoveFacetFromObjectInput) Validate

func (s *RemoveFacetFromObjectInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RemoveFacetFromObjectOutput

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

func (RemoveFacetFromObjectOutput) GoString

func (s RemoveFacetFromObjectOutput) GoString() string

GoString returns the string representation

func (RemoveFacetFromObjectOutput) String

String returns the string representation

type Rule

type Rule struct {

	// The minimum and maximum parameters that are associated with the rule.
	Parameters map[string]*string `type:"map"`

	// The type of attribute validation rule.
	Type *string `type:"string" enum:"RuleType"`
	// contains filtered or unexported fields
}

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

func (Rule) GoString

func (s Rule) GoString() string

GoString returns the string representation

func (*Rule) SetParameters

func (s *Rule) SetParameters(v map[string]*string) *Rule

SetParameters sets the Parameters field's value.

func (*Rule) SetType

func (s *Rule) SetType(v string) *Rule

SetType sets the Type field's value.

func (Rule) String

func (s Rule) String() string

String returns the string representation

type SchemaFacet

type SchemaFacet struct {

	// The name of the facet.
	FacetName *string `min:"1" type:"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.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

A facet.

func (SchemaFacet) GoString

func (s SchemaFacet) GoString() string

GoString returns the string representation

func (*SchemaFacet) SetFacetName

func (s *SchemaFacet) SetFacetName(v string) *SchemaFacet

SetFacetName sets the FacetName field's value.

func (*SchemaFacet) SetSchemaArn

func (s *SchemaFacet) SetSchemaArn(v string) *SchemaFacet

SetSchemaArn sets the SchemaArn field's value.

func (SchemaFacet) String

func (s SchemaFacet) String() string

String returns the string representation

func (*SchemaFacet) Validate

func (s *SchemaFacet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag

type Tag struct {

	// The key that is associated with the tag.
	Key *string `type:"string"`

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

The tag structure that contains a tag key and value.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. Tagging is only supported
	// for directories.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// A list of tag key-value pairs.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type TypedAttributeValue

type TypedAttributeValue struct {

	// A binary data value.
	//
	// BinaryValue is automatically base64 encoded/decoded by the SDK.
	BinaryValue []byte `type:"blob"`

	// A Boolean data value.
	BooleanValue *bool `type:"boolean"`

	// A date and time value.
	DatetimeValue *time.Time `type:"timestamp"`

	// A number data value.
	NumberValue *string `type:"string"`

	// A string data value.
	StringValue *string `type:"string"`
	// contains filtered or unexported fields
}

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.

func (TypedAttributeValue) GoString

func (s TypedAttributeValue) GoString() string

GoString returns the string representation

func (*TypedAttributeValue) SetBinaryValue

func (s *TypedAttributeValue) SetBinaryValue(v []byte) *TypedAttributeValue

SetBinaryValue sets the BinaryValue field's value.

func (*TypedAttributeValue) SetBooleanValue

func (s *TypedAttributeValue) SetBooleanValue(v bool) *TypedAttributeValue

SetBooleanValue sets the BooleanValue field's value.

func (*TypedAttributeValue) SetDatetimeValue

func (s *TypedAttributeValue) SetDatetimeValue(v time.Time) *TypedAttributeValue

SetDatetimeValue sets the DatetimeValue field's value.

func (*TypedAttributeValue) SetNumberValue

func (s *TypedAttributeValue) SetNumberValue(v string) *TypedAttributeValue

SetNumberValue sets the NumberValue field's value.

func (*TypedAttributeValue) SetStringValue

func (s *TypedAttributeValue) SetStringValue(v string) *TypedAttributeValue

SetStringValue sets the StringValue field's value.

func (TypedAttributeValue) String

func (s TypedAttributeValue) String() string

String returns the string representation

type TypedAttributeValueRange

type TypedAttributeValueRange struct {

	// The inclusive or exclusive range end.
	//
	// EndMode is a required field
	EndMode *string `type:"string" required:"true" enum:"RangeMode"`

	// The attribute value to terminate the range at.
	EndValue *TypedAttributeValue `type:"structure"`

	// The inclusive or exclusive range start.
	//
	// StartMode is a required field
	StartMode *string `type:"string" required:"true" enum:"RangeMode"`

	// The value to start the range at.
	StartValue *TypedAttributeValue `type:"structure"`
	// 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).

func (TypedAttributeValueRange) GoString

func (s TypedAttributeValueRange) GoString() string

GoString returns the string representation

func (*TypedAttributeValueRange) SetEndMode

SetEndMode sets the EndMode field's value.

func (*TypedAttributeValueRange) SetEndValue

SetEndValue sets the EndValue field's value.

func (*TypedAttributeValueRange) SetStartMode

SetStartMode sets the StartMode field's value.

func (*TypedAttributeValueRange) SetStartValue

SetStartValue sets the StartValue field's value.

func (TypedAttributeValueRange) String

func (s TypedAttributeValueRange) String() string

String returns the string representation

func (*TypedAttributeValueRange) Validate

func (s *TypedAttributeValueRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypedLinkAttributeDefinition added in v1.8.31

type TypedLinkAttributeDefinition struct {

	// The default value of the attribute (if configured).
	DefaultValue *TypedAttributeValue `type:"structure"`

	// Whether the attribute is mutable or not.
	IsImmutable *bool `type:"boolean"`

	// The unique name of the typed link attribute.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The required behavior of the TypedLinkAttributeDefinition.
	//
	// RequiredBehavior is a required field
	RequiredBehavior *string `type:"string" required:"true" enum:"RequiredAttributeBehavior"`

	// Validation rules that are attached to the attribute definition.
	Rules map[string]*Rule `type:"map"`

	// The type of the attribute.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"FacetAttributeType"`
	// contains filtered or unexported fields
}

A typed link attribute definition.

func (TypedLinkAttributeDefinition) GoString added in v1.8.31

func (s TypedLinkAttributeDefinition) GoString() string

GoString returns the string representation

func (*TypedLinkAttributeDefinition) SetDefaultValue added in v1.8.31

SetDefaultValue sets the DefaultValue field's value.

func (*TypedLinkAttributeDefinition) SetIsImmutable added in v1.8.31

SetIsImmutable sets the IsImmutable field's value.

func (*TypedLinkAttributeDefinition) SetName added in v1.8.31

SetName sets the Name field's value.

func (*TypedLinkAttributeDefinition) SetRequiredBehavior added in v1.8.31

SetRequiredBehavior sets the RequiredBehavior field's value.

func (*TypedLinkAttributeDefinition) SetRules added in v1.8.31

SetRules sets the Rules field's value.

func (*TypedLinkAttributeDefinition) SetType added in v1.8.31

SetType sets the Type field's value.

func (TypedLinkAttributeDefinition) String added in v1.8.31

String returns the string representation

func (*TypedLinkAttributeDefinition) Validate added in v1.8.31

func (s *TypedLinkAttributeDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypedLinkAttributeRange added in v1.8.31

type TypedLinkAttributeRange struct {

	// The unique name of the typed link attribute.
	AttributeName *string `min:"1" type:"string"`

	// The range of attribute values that are being selected.
	//
	// Range is a required field
	Range *TypedAttributeValueRange `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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

func (TypedLinkAttributeRange) GoString added in v1.8.31

func (s TypedLinkAttributeRange) GoString() string

GoString returns the string representation

func (*TypedLinkAttributeRange) SetAttributeName added in v1.8.31

func (s *TypedLinkAttributeRange) SetAttributeName(v string) *TypedLinkAttributeRange

SetAttributeName sets the AttributeName field's value.

func (*TypedLinkAttributeRange) SetRange added in v1.8.31

SetRange sets the Range field's value.

func (TypedLinkAttributeRange) String added in v1.8.31

func (s TypedLinkAttributeRange) String() string

String returns the string representation

func (*TypedLinkAttributeRange) Validate added in v1.8.31

func (s *TypedLinkAttributeRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypedLinkFacet added in v1.8.31

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.
	//
	// Attributes is a required field
	Attributes []*TypedLinkAttributeDefinition `type:"list" required:"true"`

	// 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.
	//
	// IdentityAttributeOrder is a required field
	IdentityAttributeOrder []*string `type:"list" required:"true"`

	// The unique name of the typed link facet.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (TypedLinkFacet) GoString added in v1.8.31

func (s TypedLinkFacet) GoString() string

GoString returns the string representation

func (*TypedLinkFacet) SetAttributes added in v1.8.31

SetAttributes sets the Attributes field's value.

func (*TypedLinkFacet) SetIdentityAttributeOrder added in v1.8.31

func (s *TypedLinkFacet) SetIdentityAttributeOrder(v []*string) *TypedLinkFacet

SetIdentityAttributeOrder sets the IdentityAttributeOrder field's value.

func (*TypedLinkFacet) SetName added in v1.8.31

func (s *TypedLinkFacet) SetName(v string) *TypedLinkFacet

SetName sets the Name field's value.

func (TypedLinkFacet) String added in v1.8.31

func (s TypedLinkFacet) String() string

String returns the string representation

func (*TypedLinkFacet) Validate added in v1.8.31

func (s *TypedLinkFacet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypedLinkFacetAttributeUpdate added in v1.8.31

type TypedLinkFacetAttributeUpdate struct {

	// The action to perform when updating the attribute.
	//
	// Action is a required field
	Action *string `type:"string" required:"true" enum:"UpdateActionType"`

	// The attribute to update.
	//
	// Attribute is a required field
	Attribute *TypedLinkAttributeDefinition `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A typed link facet attribute update.

func (TypedLinkFacetAttributeUpdate) GoString added in v1.8.31

GoString returns the string representation

func (*TypedLinkFacetAttributeUpdate) SetAction added in v1.8.31

SetAction sets the Action field's value.

func (*TypedLinkFacetAttributeUpdate) SetAttribute added in v1.8.31

SetAttribute sets the Attribute field's value.

func (TypedLinkFacetAttributeUpdate) String added in v1.8.31

String returns the string representation

func (*TypedLinkFacetAttributeUpdate) Validate added in v1.8.31

func (s *TypedLinkFacetAttributeUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypedLinkSchemaAndFacetName added in v1.8.31

type TypedLinkSchemaAndFacetName struct {

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `type:"string" required:"true"`

	// The unique name of the typed link facet.
	//
	// TypedLinkName is a required field
	TypedLinkName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (TypedLinkSchemaAndFacetName) GoString added in v1.8.31

func (s TypedLinkSchemaAndFacetName) GoString() string

GoString returns the string representation

func (*TypedLinkSchemaAndFacetName) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (*TypedLinkSchemaAndFacetName) SetTypedLinkName added in v1.8.31

SetTypedLinkName sets the TypedLinkName field's value.

func (TypedLinkSchemaAndFacetName) String added in v1.8.31

String returns the string representation

func (*TypedLinkSchemaAndFacetName) Validate added in v1.8.31

func (s *TypedLinkSchemaAndFacetName) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TypedLinkSpecifier added in v1.8.31

type TypedLinkSpecifier struct {

	// Identifies the attribute value to update.
	//
	// IdentityAttributeValues is a required field
	IdentityAttributeValues []*AttributeNameAndValue `type:"list" required:"true"`

	// Identifies the source object that the typed link will attach to.
	//
	// SourceObjectReference is a required field
	SourceObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifies the target object that the typed link will attach to.
	//
	// TargetObjectReference is a required field
	TargetObjectReference *ObjectReference `type:"structure" required:"true"`

	// Identifies the typed link facet that is associated with the typed link.
	//
	// TypedLinkFacet is a required field
	TypedLinkFacet *TypedLinkSchemaAndFacetName `type:"structure" required:"true"`
	// 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.

func (TypedLinkSpecifier) GoString added in v1.8.31

func (s TypedLinkSpecifier) GoString() string

GoString returns the string representation

func (*TypedLinkSpecifier) SetIdentityAttributeValues added in v1.8.31

func (s *TypedLinkSpecifier) SetIdentityAttributeValues(v []*AttributeNameAndValue) *TypedLinkSpecifier

SetIdentityAttributeValues sets the IdentityAttributeValues field's value.

func (*TypedLinkSpecifier) SetSourceObjectReference added in v1.8.31

func (s *TypedLinkSpecifier) SetSourceObjectReference(v *ObjectReference) *TypedLinkSpecifier

SetSourceObjectReference sets the SourceObjectReference field's value.

func (*TypedLinkSpecifier) SetTargetObjectReference added in v1.8.31

func (s *TypedLinkSpecifier) SetTargetObjectReference(v *ObjectReference) *TypedLinkSpecifier

SetTargetObjectReference sets the TargetObjectReference field's value.

func (*TypedLinkSpecifier) SetTypedLinkFacet added in v1.8.31

SetTypedLinkFacet sets the TypedLinkFacet field's value.

func (TypedLinkSpecifier) String added in v1.8.31

func (s TypedLinkSpecifier) String() string

String returns the string representation

func (*TypedLinkSpecifier) Validate added in v1.8.31

func (s *TypedLinkSpecifier) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource. Tagging is only supported
	// for directories.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// Keys of the tag that need to be removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateFacetInput

type UpdateFacetInput struct {

	// 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.
	AttributeUpdates []*FacetAttributeUpdate `type:"list"`

	// The name of the facet.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The object type that is associated with the facet. See CreateFacetRequest$ObjectType
	// for more details.
	ObjectType *string `type:"string" enum:"ObjectType"`

	// The Amazon Resource Name (ARN) that is associated with the Facet. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFacetInput) GoString

func (s UpdateFacetInput) GoString() string

GoString returns the string representation

func (*UpdateFacetInput) SetAttributeUpdates

func (s *UpdateFacetInput) SetAttributeUpdates(v []*FacetAttributeUpdate) *UpdateFacetInput

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*UpdateFacetInput) SetName

func (s *UpdateFacetInput) SetName(v string) *UpdateFacetInput

SetName sets the Name field's value.

func (*UpdateFacetInput) SetObjectType

func (s *UpdateFacetInput) SetObjectType(v string) *UpdateFacetInput

SetObjectType sets the ObjectType field's value.

func (*UpdateFacetInput) SetSchemaArn

func (s *UpdateFacetInput) SetSchemaArn(v string) *UpdateFacetInput

SetSchemaArn sets the SchemaArn field's value.

func (UpdateFacetInput) String

func (s UpdateFacetInput) String() string

String returns the string representation

func (*UpdateFacetInput) Validate

func (s *UpdateFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFacetOutput

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

func (UpdateFacetOutput) GoString

func (s UpdateFacetOutput) GoString() string

GoString returns the string representation

func (UpdateFacetOutput) String

func (s UpdateFacetOutput) String() string

String returns the string representation

type UpdateLinkAttributesInput added in v1.14.4

type UpdateLinkAttributesInput struct {

	// The attributes update structure.
	//
	// AttributeUpdates is a required field
	AttributeUpdates []*LinkAttributeUpdate `type:"list" required:"true"`

	// 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
	// (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// Allows a typed link specifier to be accepted as input.
	//
	// TypedLinkSpecifier is a required field
	TypedLinkSpecifier *TypedLinkSpecifier `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateLinkAttributesInput) GoString added in v1.14.4

func (s UpdateLinkAttributesInput) GoString() string

GoString returns the string representation

func (*UpdateLinkAttributesInput) SetAttributeUpdates added in v1.14.4

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*UpdateLinkAttributesInput) SetDirectoryArn added in v1.14.4

SetDirectoryArn sets the DirectoryArn field's value.

func (*UpdateLinkAttributesInput) SetTypedLinkSpecifier added in v1.14.4

SetTypedLinkSpecifier sets the TypedLinkSpecifier field's value.

func (UpdateLinkAttributesInput) String added in v1.14.4

func (s UpdateLinkAttributesInput) String() string

String returns the string representation

func (*UpdateLinkAttributesInput) Validate added in v1.14.4

func (s *UpdateLinkAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLinkAttributesOutput added in v1.14.4

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

func (UpdateLinkAttributesOutput) GoString added in v1.14.4

func (s UpdateLinkAttributesOutput) GoString() string

GoString returns the string representation

func (UpdateLinkAttributesOutput) String added in v1.14.4

String returns the string representation

type UpdateObjectAttributesInput

type UpdateObjectAttributesInput struct {

	// The attributes update structure.
	//
	// AttributeUpdates is a required field
	AttributeUpdates []*ObjectAttributeUpdate `type:"list" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the Directory where
	// the object resides. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`

	// The reference that identifies the object.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateObjectAttributesInput) GoString

func (s UpdateObjectAttributesInput) GoString() string

GoString returns the string representation

func (*UpdateObjectAttributesInput) SetAttributeUpdates

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*UpdateObjectAttributesInput) SetDirectoryArn

SetDirectoryArn sets the DirectoryArn field's value.

func (*UpdateObjectAttributesInput) SetObjectReference

SetObjectReference sets the ObjectReference field's value.

func (UpdateObjectAttributesInput) String

String returns the string representation

func (*UpdateObjectAttributesInput) Validate

func (s *UpdateObjectAttributesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateObjectAttributesOutput

type UpdateObjectAttributesOutput struct {

	// The ObjectIdentifier of the updated object.
	ObjectIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateObjectAttributesOutput) GoString

func (s UpdateObjectAttributesOutput) GoString() string

GoString returns the string representation

func (*UpdateObjectAttributesOutput) SetObjectIdentifier

SetObjectIdentifier sets the ObjectIdentifier field's value.

func (UpdateObjectAttributesOutput) String

String returns the string representation

type UpdateSchemaInput

type UpdateSchemaInput struct {

	// The name of the schema.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the development schema. For more information,
	// see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateSchemaInput) GoString

func (s UpdateSchemaInput) GoString() string

GoString returns the string representation

func (*UpdateSchemaInput) SetName

SetName sets the Name field's value.

func (*UpdateSchemaInput) SetSchemaArn

func (s *UpdateSchemaInput) SetSchemaArn(v string) *UpdateSchemaInput

SetSchemaArn sets the SchemaArn field's value.

func (UpdateSchemaInput) String

func (s UpdateSchemaInput) String() string

String returns the string representation

func (*UpdateSchemaInput) Validate

func (s *UpdateSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateSchemaOutput

type UpdateSchemaOutput struct {

	// The ARN that is associated with the updated schema. For more information,
	// see arns.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSchemaOutput) GoString

func (s UpdateSchemaOutput) GoString() string

GoString returns the string representation

func (*UpdateSchemaOutput) SetSchemaArn

func (s *UpdateSchemaOutput) SetSchemaArn(v string) *UpdateSchemaOutput

SetSchemaArn sets the SchemaArn field's value.

func (UpdateSchemaOutput) String

func (s UpdateSchemaOutput) String() string

String returns the string representation

type UpdateTypedLinkFacetInput added in v1.8.31

type UpdateTypedLinkFacetInput struct {

	// Attributes update structure.
	//
	// AttributeUpdates is a required field
	AttributeUpdates []*TypedLinkFacetAttributeUpdate `type:"list" required:"true"`

	// 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 (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
	//
	// IdentityAttributeOrder is a required field
	IdentityAttributeOrder []*string `type:"list" required:"true"`

	// The unique name of the typed link facet.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that is associated with the schema. For more
	// information, see arns.
	//
	// SchemaArn is a required field
	SchemaArn *string `location:"header" locationName:"x-amz-data-partition" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTypedLinkFacetInput) GoString added in v1.8.31

func (s UpdateTypedLinkFacetInput) GoString() string

GoString returns the string representation

func (*UpdateTypedLinkFacetInput) SetAttributeUpdates added in v1.8.31

SetAttributeUpdates sets the AttributeUpdates field's value.

func (*UpdateTypedLinkFacetInput) SetIdentityAttributeOrder added in v1.8.31

func (s *UpdateTypedLinkFacetInput) SetIdentityAttributeOrder(v []*string) *UpdateTypedLinkFacetInput

SetIdentityAttributeOrder sets the IdentityAttributeOrder field's value.

func (*UpdateTypedLinkFacetInput) SetName added in v1.8.31

SetName sets the Name field's value.

func (*UpdateTypedLinkFacetInput) SetSchemaArn added in v1.8.31

SetSchemaArn sets the SchemaArn field's value.

func (UpdateTypedLinkFacetInput) String added in v1.8.31

func (s UpdateTypedLinkFacetInput) String() string

String returns the string representation

func (*UpdateTypedLinkFacetInput) Validate added in v1.8.31

func (s *UpdateTypedLinkFacetInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTypedLinkFacetOutput added in v1.8.31

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

func (UpdateTypedLinkFacetOutput) GoString added in v1.8.31

func (s UpdateTypedLinkFacetOutput) GoString() string

GoString returns the string representation

func (UpdateTypedLinkFacetOutput) String added in v1.8.31

String returns the string representation

type UpgradeAppliedSchemaInput added in v1.12.43

type UpgradeAppliedSchemaInput struct {

	// The ARN for the directory to which the upgraded schema will be applied.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`

	// 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.
	DryRun *bool `type:"boolean"`

	// The revision of the published schema to upgrade the directory to.
	//
	// PublishedSchemaArn is a required field
	PublishedSchemaArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpgradeAppliedSchemaInput) GoString added in v1.12.43

func (s UpgradeAppliedSchemaInput) GoString() string

GoString returns the string representation

func (*UpgradeAppliedSchemaInput) SetDirectoryArn added in v1.12.43

SetDirectoryArn sets the DirectoryArn field's value.

func (*UpgradeAppliedSchemaInput) SetDryRun added in v1.12.43

SetDryRun sets the DryRun field's value.

func (*UpgradeAppliedSchemaInput) SetPublishedSchemaArn added in v1.12.43

func (s *UpgradeAppliedSchemaInput) SetPublishedSchemaArn(v string) *UpgradeAppliedSchemaInput

SetPublishedSchemaArn sets the PublishedSchemaArn field's value.

func (UpgradeAppliedSchemaInput) String added in v1.12.43

func (s UpgradeAppliedSchemaInput) String() string

String returns the string representation

func (*UpgradeAppliedSchemaInput) Validate added in v1.12.43

func (s *UpgradeAppliedSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpgradeAppliedSchemaOutput added in v1.12.43

type UpgradeAppliedSchemaOutput struct {

	// The ARN of the directory that is returned as part of the response.
	DirectoryArn *string `type:"string"`

	// The ARN of the upgraded schema that is returned as part of the response.
	UpgradedSchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpgradeAppliedSchemaOutput) GoString added in v1.12.43

func (s UpgradeAppliedSchemaOutput) GoString() string

GoString returns the string representation

func (*UpgradeAppliedSchemaOutput) SetDirectoryArn added in v1.12.43

SetDirectoryArn sets the DirectoryArn field's value.

func (*UpgradeAppliedSchemaOutput) SetUpgradedSchemaArn added in v1.12.43

func (s *UpgradeAppliedSchemaOutput) SetUpgradedSchemaArn(v string) *UpgradeAppliedSchemaOutput

SetUpgradedSchemaArn sets the UpgradedSchemaArn field's value.

func (UpgradeAppliedSchemaOutput) String added in v1.12.43

String returns the string representation

type UpgradePublishedSchemaInput added in v1.12.43

type UpgradePublishedSchemaInput struct {

	// The ARN of the development schema with the changes used for the upgrade.
	//
	// DevelopmentSchemaArn is a required field
	DevelopmentSchemaArn *string `type:"string" required:"true"`

	// 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.
	DryRun *bool `type:"boolean"`

	// Identifies the minor version of the published schema that will be created.
	// This parameter is NOT optional.
	//
	// MinorVersion is a required field
	MinorVersion *string `min:"1" type:"string" required:"true"`

	// The ARN of the published schema to be upgraded.
	//
	// PublishedSchemaArn is a required field
	PublishedSchemaArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpgradePublishedSchemaInput) GoString added in v1.12.43

func (s UpgradePublishedSchemaInput) GoString() string

GoString returns the string representation

func (*UpgradePublishedSchemaInput) SetDevelopmentSchemaArn added in v1.12.43

func (s *UpgradePublishedSchemaInput) SetDevelopmentSchemaArn(v string) *UpgradePublishedSchemaInput

SetDevelopmentSchemaArn sets the DevelopmentSchemaArn field's value.

func (*UpgradePublishedSchemaInput) SetDryRun added in v1.12.43

SetDryRun sets the DryRun field's value.

func (*UpgradePublishedSchemaInput) SetMinorVersion added in v1.12.43

SetMinorVersion sets the MinorVersion field's value.

func (*UpgradePublishedSchemaInput) SetPublishedSchemaArn added in v1.12.43

func (s *UpgradePublishedSchemaInput) SetPublishedSchemaArn(v string) *UpgradePublishedSchemaInput

SetPublishedSchemaArn sets the PublishedSchemaArn field's value.

func (UpgradePublishedSchemaInput) String added in v1.12.43

String returns the string representation

func (*UpgradePublishedSchemaInput) Validate added in v1.12.43

func (s *UpgradePublishedSchemaInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpgradePublishedSchemaOutput added in v1.12.43

type UpgradePublishedSchemaOutput struct {

	// The ARN of the upgraded schema that is returned as part of the response.
	UpgradedSchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpgradePublishedSchemaOutput) GoString added in v1.12.43

func (s UpgradePublishedSchemaOutput) GoString() string

GoString returns the string representation

func (*UpgradePublishedSchemaOutput) SetUpgradedSchemaArn added in v1.12.43

SetUpgradedSchemaArn sets the UpgradedSchemaArn field's value.

func (UpgradePublishedSchemaOutput) String added in v1.12.43

String returns the string representation

Directories

Path Synopsis
Package clouddirectoryiface provides an interface to enable mocking the Amazon CloudDirectory service client for testing your code.
Package clouddirectoryiface provides an interface to enable mocking the Amazon CloudDirectory service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL