clouddirectory

package
v1.8.21 Latest Latest
Warning

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

Go to latest
Published: May 9, 2017 License: Apache-2.0 Imports: 8 Imported by: 0

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 programatically and includes detailed information on data types and errors. For information about AWS Directory Services features, see AWS Directory Service (https://aws.amazon.com/directoryservice/) and the AWS Directory Service Administration Guide (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/what_is.html).

See https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10 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 use the client for Amazon CloudDirectory you will first need to create a new instance of it.

When creating a client for an AWS service you'll first need to have a Session already created. The Session provides configuration that can be shared between multiple service clients. Additional configuration can be applied to the Session and service's client when they are constructed. The aws package's Config type contains several fields such as Region for the AWS Region the client should make API requests too. The optional Config value can be provided as the variadic argument for Sessions and client creation.

Once the service's client is created you can use it to make API requests the AWS service. These clients are safe to use concurrently.

// Create a session to share configuration, and load external configuration.
sess := session.Must(session.NewSession())

// Create the service's client with the session.
svc := clouddirectory.New(sess)

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

See aws package's Config type for more information on configuration options. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

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

Once the client is created you can make an API request to the service. Each API method takes a input parameter, and returns the service response and an error.

The API method will document which error codes the service can be returned by the operation if the service models the API operation's errors. These errors will also be available as const strings prefixed with "ErrCode".

result, err := svc.AddFacetToObject(params)
if err != nil {
    // Cast err to awserr.Error to handle specific error codes.
    aerr, ok := err.(awserr.Error)
    if ok && aerr.Code() == <error code to check for> {
        // Specific error code handling
    }
    return err
}

fmt.Println("AddFacetToObject result:")
fmt.Println(result)

Using the Client with Context

The service's client also provides methods to make API requests with a Context value. This allows you to control the timeout, and cancellation of pending requests. These methods also take request Option as variadic parameter to apply additional configuration to the API request.

ctx := context.Background()

result, err := svc.AddFacetToObjectWithContext(ctx, params)

See the request package documentation for more information on using Context pattern with the SDK. https://docs.aws.amazon.com/sdk-for-go/api/aws/request/

Index

Examples

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"
)
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"
)
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"
)
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 has been attempted to be accessed. 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".
	//
	// An operation can only operate on a directory that is not enabled.
	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 which 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 you provided was not well formed or could not be validated with
	// the schema.
	ErrCodeFacetValidationException = "FacetValidationException"

	// 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 attach an object with the same link name or
	// to apply a schema with same name has occurred. Rename the link or the schema
	// and then try again.
	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 limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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 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 which is not
	// a node, such as calling ListObjectChildren for a leaf node object.
	ErrCodeNotNodeException = "NotNodeException"

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

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

	// ErrCodeObjectNotDetachedException for service response error code
	// "ObjectNotDetachedException".
	//
	// Indicates 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 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 the requested index type is not supported.
	ErrCodeUnsupportedIndexTypeException = "UnsupportedIndexTypeException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// Indicates your request is malformed in some manner. See the exception message.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "clouddirectory" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName      // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type AddFacetToObjectInput

type AddFacetToObjectInput struct {

	// ARN 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 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.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AddFacetToObjectRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AddFacetToObjectResponse

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 {

	// ARN 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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchemaRequest

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 {

	// Applied schema ARN 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"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchemaResponse

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 {

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

	// ARN 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"`

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObjectRequest

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 {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObjectResponse

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 {

	// ARN associated with the Directory where both objects reside. For more information,
	// see arns.
	DirectoryArn *string `location:"header" locationName:"x-amz-data-partition" type:"string"`

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachPolicyRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachPolicyResponse

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachToIndexRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachToIndexResponse

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 AttributeKey

type AttributeKey struct {

	// The name of the facet 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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttributeKey

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttributeKeyAndValue

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAddFacetToObject

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAddFacetToObjectResponse

func (BatchAddFacetToObjectResponse) GoString

GoString returns the string representation

func (BatchAddFacetToObjectResponse) String

String returns the string representation

type BatchAttachObject

type BatchAttachObject struct {

	// Child object reference 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 `type:"string" required:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAttachObject

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchAttachObjectResponse

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 BatchCreateObject

type BatchCreateObject struct {

	// The batch reference name. See Batches (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches)
	// for more information.
	//
	// BatchReferenceName is a required field
	BatchReferenceName *string `type:"string" required:"true"`

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

	// 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 is a required field
	ParentReference *ObjectReference `type:"structure" required:"true"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchCreateObject

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 {

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

Represents the output of a CreateObject response operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchCreateObjectResponse

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 {

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDeleteObject

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDeleteObjectResponse

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 BatchDetachObject

type BatchDetachObject struct {

	// The batch reference name. See Batches (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#batches)
	// for more information.
	//
	// BatchReferenceName is a required field
	BatchReferenceName *string `type:"string" required:"true"`

	// The name of the link.
	//
	// LinkName is a required field
	LinkName *string `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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDetachObject

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchDetachObjectResponse

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 BatchListObjectAttributes

type BatchListObjectAttributes struct {

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

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectAttributes

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 {

	// Attributes map 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectAttributesResponse

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectChildren

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 {

	// 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
}

Represents the output of a ListObjectChildren response operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchListObjectChildrenResponse

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 BatchReadException

type BatchReadException struct {

	// Exception message associated with the failure.
	Message *string `type:"string"`

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

Batch Read Exception structure, which contains exception type and message. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadException

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"`

	// ARN 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"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadRequest

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 {

	// Lists all attributes 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"`
	// contains filtered or unexported fields
}

Represents the output of a BatchRead operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadOperation

func (BatchReadOperation) GoString

func (s BatchReadOperation) GoString() string

GoString returns the string representation

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) 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadOperationResponse

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 {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadResponse

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 {

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

	// Returns a paginated list of child objects associated with a given object.
	ListObjectChildren *BatchListObjectChildrenResponse `type:"structure"`
	// contains filtered or unexported fields
}

Represents the output of a BatchRead success response operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchReadSuccessfulResponse

func (BatchReadSuccessfulResponse) GoString

func (s BatchReadSuccessfulResponse) GoString() string

GoString returns the string representation

func (*BatchReadSuccessfulResponse) SetListObjectAttributes

SetListObjectAttributes sets the ListObjectAttributes field's value.

func (*BatchReadSuccessfulResponse) SetListObjectChildren

SetListObjectChildren sets the ListObjectChildren 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
}

Batch operation to remove a facet from an object. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchRemoveFacetFromObject

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
}

Empty result representing success. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchRemoveFacetFromObjectResponse

func (BatchRemoveFacetFromObjectResponse) GoString

GoString returns the string representation

func (BatchRemoveFacetFromObjectResponse) String

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchUpdateObjectAttributes

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 associated with the object.
	ObjectIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Represents the output of a BatchUpdate response operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchUpdateObjectAttributesResponse

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 {

	// ARN 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"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteRequest

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 {

	// Batch operation adding a facet to an object.
	AddFacetToObject *BatchAddFacetToObject `type:"structure"`

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

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

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

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

	// Batch operation removing a facet from an object.
	RemoveFacetFromObject *BatchRemoveFacetFromObject `type:"structure"`

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

Represents the output of a BatchWrite operation. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteOperation

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

SetCreateObject sets the CreateObject field's value.

func (*BatchWriteOperation) SetDeleteObject

SetDeleteObject sets the DeleteObject field's value.

func (*BatchWriteOperation) SetDetachObject

SetDetachObject sets the DetachObject field's value.

func (*BatchWriteOperation) SetRemoveFacetFromObject

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

SetRemoveFacetFromObject sets the RemoveFacetFromObject 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 {

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

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

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

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

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

	// Result of a batch remove facet from object operation.
	RemoveFacetFromObject *BatchRemoveFacetFromObjectResponse `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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteOperationResponse

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

SetCreateObject sets the CreateObject field's value.

func (*BatchWriteOperationResponse) SetDeleteObject

SetDeleteObject sets the DeleteObject field's value.

func (*BatchWriteOperationResponse) SetDetachObject

SetDetachObject sets the DetachObject field's value.

func (*BatchWriteOperationResponse) SetRemoveFacetFromObject

SetRemoveFacetFromObject sets the RemoveFacetFromObject 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 {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWriteResponse

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.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AddFacetToObject

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See AddFacetToObject for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddFacetToObject method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 input published schema into Directory with same name and version as that of 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

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

  • ErrCodeInvalidAttachmentException "InvalidAttachmentException" Indicates that an attempt to attach an object with the same link name or to apply a schema with same name has occurred. Rename the link or the schema and then try again.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ApplySchema

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See ApplySchema for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ApplySchema method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

  • 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 attach an object with the same link name or to apply a schema with same name has occurred. Rename the link or the schema and then try again.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachObject

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See AttachObject for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AttachObject method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachPolicy

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See AttachPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AttachPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

  • 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 the requested operation can only operate on index objects.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/AttachToIndex

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See AttachToIndex for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AttachToIndex method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (*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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchRead

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See BatchRead for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the BatchRead method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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. Batch writes supports only object-related operations.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

  • ErrCodeBatchWriteException "BatchWriteException" A BatchWrite exception has occurred.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/BatchWrite

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See BatchWrite for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the BatchWrite method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateDirectory

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateDirectory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateDirectory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateFacet

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateFacet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateFacet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_indexing.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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • ErrCodeFacetValidationException "FacetValidationException" The Facet 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 the requested index type is not supported.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateIndex

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateIndex for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateIndex method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

  • ErrCodeFacetValidationException "FacetValidationException" The Facet 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 the requested index type is not supported.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateObject

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateObject for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateObject method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchema

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See CreateSchema for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateSchema method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryDeletedException "DirectoryDeletedException" A directory that has been deleted has been attempted to be accessed. 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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteDirectory

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteDirectory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteDirectory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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 which is a target to an attribute reference in a different facet.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteFacet

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteFacet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteFacet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • ErrCodeObjectNotDetachedException "ObjectNotDetachedException" Indicates the requested operation cannot be completed because the object has not been detached from the tree.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteObject

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteObject for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteObject method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteSchema

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DeleteSchema for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteSchema method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • ErrCodeObjectAlreadyDetachedException "ObjectAlreadyDetachedException" Indicates the object is not attached to the index.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachFromIndex

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DetachFromIndex for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DetachFromIndex method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachObject

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DetachObject for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DetachObject method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachPolicy

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DetachPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DetachPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (*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 has been attempted to be accessed. 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DisableDirectory

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See DisableDirectory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DisableDirectory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 has been attempted to be accessed. 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/EnableDirectory

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See EnableDirectory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the EnableDirectory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetDirectory

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetDirectory for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetDirectory method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetFacet

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetFacet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetFacet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetObjectInformation

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetObjectInformation for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetObjectInformation method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetSchemaAsJson

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See GetSchemaAsJson for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetSchemaAsJson method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) ListAppliedSchemaArns

func (c *CloudDirectory) ListAppliedSchemaArns(input *ListAppliedSchemaArnsInput) (*ListAppliedSchemaArnsOutput, error)

ListAppliedSchemaArns API operation for Amazon CloudDirectory.

Lists schemas applied to 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 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAppliedSchemaArns

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListAppliedSchemaArns for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAppliedSchemaArns method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 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 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAttachedIndices

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListAttachedIndices for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAttachedIndices method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 the ARNs 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDevelopmentSchemaArns

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListDevelopmentSchemaArns for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListDevelopmentSchemaArns method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDirectories

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListDirectories for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListDirectories method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetAttributes

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListFacetAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListFacetAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetNames

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListFacetNames for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListFacetNames method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (*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.

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

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIndex

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListIndex for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListIndex method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) ListObjectAttributes

func (c *CloudDirectory) ListObjectAttributes(input *ListObjectAttributesInput) (*ListObjectAttributesOutput, error)

ListObjectAttributes API operation for Amazon CloudDirectory.

Lists all attributes 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectAttributes

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListObjectAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListObjectAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • 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 which is not a node, such as calling ListObjectChildren for a leaf node object.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectChildren

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListObjectChildren for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListObjectChildren method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#dirstructure).

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 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentPaths

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListObjectParentPaths for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListObjectParentPaths method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParents

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListObjectParents for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListObjectParents method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectPolicies

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListObjectPolicies for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListObjectPolicies method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (*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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPolicyAttachments

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListPolicyAttachments for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPolicyAttachments method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.

Retrieves published schema ARNs.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPublishedSchemaArns

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListPublishedSchemaArns for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListPublishedSchemaArns method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTagsForResource

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See ListTagsForResource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTagsForResource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) 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.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

  • ErrCodeInvalidNextTokenException "InvalidNextTokenException" Indicates that the NextToken value is not valid.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicy

Example
Output:

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 *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 can be used to capture response data after the request's "Send" method is called.

See LookupPolicy for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the LookupPolicy method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 version. If description and attributes are specified, PublishSchema overrides the development schema description and attributes. If not, the development schema description and attributes are used.

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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

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

  • ErrCodeSchemaAlreadyPublishedException "SchemaAlreadyPublishedException" Indicates a schema is already published.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchema

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See PublishSchema for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PublishSchema method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_schemas.html#jsonformat) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PutSchemaFromJson

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See PutSchemaFromJson for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the PutSchemaFromJson method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/RemoveFacetFromObject

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See RemoveFacetFromObject for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveFacetFromObject method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.

API 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TagResource

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See TagResource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the TagResource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.

API 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UntagResource

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See UntagResource for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UntagResource method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/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.

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateFacet

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateFacet for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateFacet method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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) 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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

  • ErrCodeDirectoryNotEnabledException "DirectoryNotEnabledException" An operation can only operate on a directory that is not enabled.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributes

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateObjectAttributes for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateObjectAttributes method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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 your request is malformed in some manner. See the exception message.

  • ErrCodeLimitExceededException "LimitExceededException" Indicates limits are exceeded. See Limits (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/limits.html) for more information.

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

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchema

Example
Output:

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 can be used to capture response data after the request's "Send" method is called.

See UpdateSchema for usage and error information.

Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the UpdateSchema method directly instead.

Note: You must call the "Send" method on the returned request object in order to execute the request.

// 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)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.

type CreateDirectoryInput

type CreateDirectoryInput struct {

	// Name of the Directory. Should be unique per account, per region.
	//
	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateDirectoryRequest

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 {

	// 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"`

	// ARN associated with the Directory. For more information, see arns.
	//
	// DirectoryArn is a required field
	DirectoryArn *string `type:"string" required:"true"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateDirectoryResponse

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 {

	// Attributes associated with the Facet.e
	Attributes []*FacetAttribute `type:"list"`

	// 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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_key_concepts.html#policies).
	//
	//    * Index: Can be created with the Index API.
	//
	// ObjectType is a required field
	ObjectType *string `type:"string" required:"true" enum:"ObjectType"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateFacetRequest

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateFacetResponse

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 objects with the same indexed attribute value can be added
	// to the index.
	//
	// 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 `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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateIndexRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateIndexResponse

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 {

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

	// 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"`

	// List of facet ARNs to be associated with the object. For more information,
	// see arns.
	//
	// SchemaFacets is a required field
	SchemaFacets []*SchemaFacet `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateObjectRequest

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 {

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateObjectResponse

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 {

	// Name 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchemaRequest

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 {

	// ARN associated with the schema. For more information, see arns.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/CreateSchemaResponse

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteDirectoryRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteDirectoryResponse

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"`

	// ARN 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteFacetRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteFacetResponse

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 {

	// ARN 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"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteObjectRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteObjectResponse

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 {

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteSchemaRequest

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 {

	// Input ARN that is returned as part of the response. For more information,
	// see arns.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DeleteSchemaResponse

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 DetachFromIndexInput

type DetachFromIndexInput struct {

	// The 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachFromIndexRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachFromIndexResponse

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 {

	// ARN 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"`

	// Link name associated with the object that needs to be detached.
	//
	// LinkName is a required field
	LinkName *string `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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachObjectRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachObjectResponse

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 {

	// ARN 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachPolicyRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DetachPolicyResponse

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 Directory

type Directory struct {

	// The date and time when the directory was created.
	CreationDateTime *time.Time `type:"timestamp" timestampFormat:"unix"`

	// ARN 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Directory

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DisableDirectoryRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/DisableDirectoryResponse

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/EnableDirectoryRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/EnableDirectoryResponse

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 {

	// The name of the Facet.
	Name *string `min:"1" type:"string"`

	// Object type 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Facet

func (Facet) GoString

func (s Facet) GoString() string

GoString returns the string representation

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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences)
	// for more information.
	AttributeDefinition *FacetAttributeDefinition `type:"structure"`

	// Attribute reference associated with the attribute. See Attribute References
	// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences)
	// 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
}

Attribute associated with the Facet. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttribute

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 (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences) for more information. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttributeDefinition

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 {

	// Target attribute name associated with the facet reference. See Attribute
	// References (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences)
	// for more information.
	//
	// TargetAttributeName is a required field
	TargetAttributeName *string `min:"1" type:"string" required:"true"`

	// Target facet name associated with the facet reference. See Attribute References
	// (http://docs.aws.amazon.com/directoryservice/latest/admin-guide/cd_advanced.html#attributereferences)
	// for more information.
	//
	// TargetFacetName is a required field
	TargetFacetName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Facet attribute reference that specifies the attribute definition which contains attribute facet name and attribute name. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttributeReference

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/FacetAttributeUpdate

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetDirectoryRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetDirectoryResponse

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"`

	// ARN 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetFacetRequest

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 {

	// Facet structure associated with the facet.
	Facet *Facet `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetFacetResponse

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetObjectInformationRequest

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.
	SchemaFacets []*SchemaFacet `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetObjectInformationResponse

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetSchemaAsJsonRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/GetSchemaAsJsonResponse

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 IndexAttachment

type IndexAttachment struct {

	// The indexed attribute values.
	IndexedAttributes []*AttributeKeyAndValue `type:"list"`

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

Represents an index and an attached object. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/IndexAttachment

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAppliedSchemaArnsRequest

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAppliedSchemaArnsResponse

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 to that has indices attached.
	//
	// TargetReference is a required field
	TargetReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAttachedIndicesRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListAttachedIndicesResponse

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDevelopmentSchemaArnsRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDevelopmentSchemaArnsResponse

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDirectoriesRequest

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListDirectoriesResponse

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetAttributesRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetAttributesResponse

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetNamesRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListFacetNamesResponse

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 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 results to retrieve from the index.
	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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIndexRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListIndexResponse

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 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"`

	// ARN 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 associated with a certain facet.
	FacetFilter *SchemaFacet `type:"structure"`

	// 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 whose attributes will be listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectAttributesRequest

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 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectAttributesResponse

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"`

	// ARN 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"`

	// 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 child objects are being listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectChildrenRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectChildrenResponse

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"`

	// 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 whose parent paths are listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentPathsRequest

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 associated with the directory.
	PathToObjectIdentifiersList []*PathToObjectIdentifiers `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentPathsResponse

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"`

	// ARN 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"`

	// 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 parent objects are being listed.
	//
	// ObjectReference is a required field
	ObjectReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentsRequest

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) 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"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectParentsResponse

func (ListObjectParentsOutput) GoString

func (s ListObjectParentsOutput) GoString() string

GoString returns the string representation

func (*ListObjectParentsOutput) SetNextToken

SetNextToken sets the NextToken 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"`

	// ARN 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"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectPoliciesRequest

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 {

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListObjectPoliciesResponse

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 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"`

	// ARN 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"`

	// 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 policy object.
	//
	// PolicyReference is a required field
	PolicyReference *ObjectReference `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPolicyAttachmentsRequest

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"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPolicyAttachmentsResponse

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPublishedSchemaArnsRequest

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListPublishedSchemaArnsResponse

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"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTagsForResourceRequest

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"`

	// List of tag key value pairs associated with the response.
	Tags []*Tag `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ListTagsForResourceResponse

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 LookupPolicyInput

type LookupPolicyInput struct {

	// ARN 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"`

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicyRequest

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.
	PolicyToPathList []*PolicyToPath `type:"list"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/LookupPolicyResponse

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 {

	// Type 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeAction

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeRange

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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectAttributeUpdate

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 ObjectReference

type ObjectReference struct {

	// Allows you to specify an object. You can identify an object in one of the
	// following ways:
	//
	//    * $ObjectIdentifier - Identifies the object by ObjectIdentifier
	//
	//    * /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
}

Reference that identifies an object. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/ObjectReference

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 used to identify the object starting from directory root.
	Path *string `type:"string"`
	// contains filtered or unexported fields
}

Returns the path to the ObjectIdentifiers associated with the directory. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PathToObjectIdentifiers

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 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PolicyAttachment

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 associated with that object and the parent to that object. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PolicyToPath

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 {

	// ARN 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"`

	// 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"`

	// Version under which the schema will be published.
	//
	// Version is a required field
	Version *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchemaRequest

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

	// ARN associated with the published schema. For more information, see arns.
	PublishedSchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PublishSchemaResponse

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PutSchemaFromJsonRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/PutSchemaFromJsonResponse

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.
	//
	// SchemaFacet is a required field
	SchemaFacet *SchemaFacet `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/RemoveFacetFromObjectRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/RemoveFacetFromObjectResponse

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 {

	// Min and max parameters 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 ARN and parameters associated with the rule. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/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.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

A facet. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/SchemaFacet

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 {

	// Key associated with the tag.
	Key *string `type:"string"`

	// Value associated with the tag.
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Tag structure which contains tag key and value. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/Tag

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 {

	// ARN of the resource. Tagging is only supported for directories.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// List of tag key value pairs.
	//
	// Tags is a required field
	Tags []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TagResourceRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TagResourceResponse

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" timestampFormat:"unix"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedAttributeValue

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 {

	// 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"`

	// 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. Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/TypedAttributeValueRange

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 UntagResourceInput

type UntagResourceInput struct {

	// 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 needs to be removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UntagResourceRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UntagResourceResponse

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"`

	// Name is a required field
	Name *string `min:"1" type:"string" required:"true"`

	// Object type associated with the facet. See CreateFacetRequest$ObjectType
	// for more details.
	ObjectType *string `type:"string" enum:"ObjectType"`

	// ARN 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateFacetRequest

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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateFacetResponse

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 UpdateObjectAttributesInput

type UpdateObjectAttributesInput struct {

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

	// ARN 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"`

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

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributesRequest

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 {

	// ObjectIdentifier of the updated object.
	ObjectIdentifier *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateObjectAttributesResponse

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 {

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

	// 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
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchemaRequest

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 {

	// ARN associated with the updated schema. For more information, see arns.
	SchemaArn *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/clouddirectory-2016-05-10/UpdateSchemaResponse

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

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