package clouddirectory
import "github.com/aws/aws-sdk-go-v2/service/clouddirectory"
Package clouddirectory provides the API client, operations, and parameter types for Amazon CloudDirectory.
Amazon Cloud Directory Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service (https://aws.amazon.com/directoryservice/) and the Amazon Cloud Directory Developer Guide (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/what_is_cloud_directory.html).
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- type AddFacetToObjectInput
- type AddFacetToObjectOutput
- type ApplySchemaInput
- type ApplySchemaOutput
- type AttachObjectInput
- type AttachObjectOutput
- type AttachPolicyInput
- type AttachPolicyOutput
- type AttachToIndexInput
- type AttachToIndexOutput
- type AttachTypedLinkInput
- type AttachTypedLinkOutput
- type BatchReadInput
- type BatchReadOutput
- type BatchWriteInput
- type BatchWriteOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) AddFacetToObject(ctx context.Context, params *AddFacetToObjectInput, optFns ...func(*Options)) (*AddFacetToObjectOutput, error)
- func (c *Client) ApplySchema(ctx context.Context, params *ApplySchemaInput, optFns ...func(*Options)) (*ApplySchemaOutput, error)
- func (c *Client) AttachObject(ctx context.Context, params *AttachObjectInput, optFns ...func(*Options)) (*AttachObjectOutput, error)
- func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error)
- func (c *Client) AttachToIndex(ctx context.Context, params *AttachToIndexInput, optFns ...func(*Options)) (*AttachToIndexOutput, error)
- func (c *Client) AttachTypedLink(ctx context.Context, params *AttachTypedLinkInput, optFns ...func(*Options)) (*AttachTypedLinkOutput, error)
- func (c *Client) BatchRead(ctx context.Context, params *BatchReadInput, optFns ...func(*Options)) (*BatchReadOutput, error)
- func (c *Client) BatchWrite(ctx context.Context, params *BatchWriteInput, optFns ...func(*Options)) (*BatchWriteOutput, error)
- func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error)
- func (c *Client) CreateFacet(ctx context.Context, params *CreateFacetInput, optFns ...func(*Options)) (*CreateFacetOutput, error)
- func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error)
- func (c *Client) CreateObject(ctx context.Context, params *CreateObjectInput, optFns ...func(*Options)) (*CreateObjectOutput, error)
- func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error)
- func (c *Client) CreateTypedLinkFacet(ctx context.Context, params *CreateTypedLinkFacetInput, optFns ...func(*Options)) (*CreateTypedLinkFacetOutput, error)
- func (c *Client) DeleteDirectory(ctx context.Context, params *DeleteDirectoryInput, optFns ...func(*Options)) (*DeleteDirectoryOutput, error)
- func (c *Client) DeleteFacet(ctx context.Context, params *DeleteFacetInput, optFns ...func(*Options)) (*DeleteFacetOutput, error)
- func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error)
- func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, optFns ...func(*Options)) (*DeleteSchemaOutput, error)
- func (c *Client) DeleteTypedLinkFacet(ctx context.Context, params *DeleteTypedLinkFacetInput, optFns ...func(*Options)) (*DeleteTypedLinkFacetOutput, error)
- func (c *Client) DetachFromIndex(ctx context.Context, params *DetachFromIndexInput, optFns ...func(*Options)) (*DetachFromIndexOutput, error)
- func (c *Client) DetachObject(ctx context.Context, params *DetachObjectInput, optFns ...func(*Options)) (*DetachObjectOutput, error)
- func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error)
- func (c *Client) DetachTypedLink(ctx context.Context, params *DetachTypedLinkInput, optFns ...func(*Options)) (*DetachTypedLinkOutput, error)
- func (c *Client) DisableDirectory(ctx context.Context, params *DisableDirectoryInput, optFns ...func(*Options)) (*DisableDirectoryOutput, error)
- func (c *Client) EnableDirectory(ctx context.Context, params *EnableDirectoryInput, optFns ...func(*Options)) (*EnableDirectoryOutput, error)
- func (c *Client) GetAppliedSchemaVersion(ctx context.Context, params *GetAppliedSchemaVersionInput, optFns ...func(*Options)) (*GetAppliedSchemaVersionOutput, error)
- func (c *Client) GetDirectory(ctx context.Context, params *GetDirectoryInput, optFns ...func(*Options)) (*GetDirectoryOutput, error)
- func (c *Client) GetFacet(ctx context.Context, params *GetFacetInput, optFns ...func(*Options)) (*GetFacetOutput, error)
- func (c *Client) GetLinkAttributes(ctx context.Context, params *GetLinkAttributesInput, optFns ...func(*Options)) (*GetLinkAttributesOutput, error)
- func (c *Client) GetObjectAttributes(ctx context.Context, params *GetObjectAttributesInput, optFns ...func(*Options)) (*GetObjectAttributesOutput, error)
- func (c *Client) GetObjectInformation(ctx context.Context, params *GetObjectInformationInput, optFns ...func(*Options)) (*GetObjectInformationOutput, error)
- func (c *Client) GetSchemaAsJson(ctx context.Context, params *GetSchemaAsJsonInput, optFns ...func(*Options)) (*GetSchemaAsJsonOutput, error)
- func (c *Client) GetTypedLinkFacetInformation(ctx context.Context, params *GetTypedLinkFacetInformationInput, optFns ...func(*Options)) (*GetTypedLinkFacetInformationOutput, error)
- func (c *Client) ListAppliedSchemaArns(ctx context.Context, params *ListAppliedSchemaArnsInput, optFns ...func(*Options)) (*ListAppliedSchemaArnsOutput, error)
- func (c *Client) ListAttachedIndices(ctx context.Context, params *ListAttachedIndicesInput, optFns ...func(*Options)) (*ListAttachedIndicesOutput, error)
- func (c *Client) ListDevelopmentSchemaArns(ctx context.Context, params *ListDevelopmentSchemaArnsInput, optFns ...func(*Options)) (*ListDevelopmentSchemaArnsOutput, error)
- func (c *Client) ListDirectories(ctx context.Context, params *ListDirectoriesInput, optFns ...func(*Options)) (*ListDirectoriesOutput, error)
- func (c *Client) ListFacetAttributes(ctx context.Context, params *ListFacetAttributesInput, optFns ...func(*Options)) (*ListFacetAttributesOutput, error)
- func (c *Client) ListFacetNames(ctx context.Context, params *ListFacetNamesInput, optFns ...func(*Options)) (*ListFacetNamesOutput, error)
- func (c *Client) ListIncomingTypedLinks(ctx context.Context, params *ListIncomingTypedLinksInput, optFns ...func(*Options)) (*ListIncomingTypedLinksOutput, error)
- func (c *Client) ListIndex(ctx context.Context, params *ListIndexInput, optFns ...func(*Options)) (*ListIndexOutput, error)
- func (c *Client) ListManagedSchemaArns(ctx context.Context, params *ListManagedSchemaArnsInput, optFns ...func(*Options)) (*ListManagedSchemaArnsOutput, error)
- func (c *Client) ListObjectAttributes(ctx context.Context, params *ListObjectAttributesInput, optFns ...func(*Options)) (*ListObjectAttributesOutput, error)
- func (c *Client) ListObjectChildren(ctx context.Context, params *ListObjectChildrenInput, optFns ...func(*Options)) (*ListObjectChildrenOutput, error)
- func (c *Client) ListObjectParentPaths(ctx context.Context, params *ListObjectParentPathsInput, optFns ...func(*Options)) (*ListObjectParentPathsOutput, error)
- func (c *Client) ListObjectParents(ctx context.Context, params *ListObjectParentsInput, optFns ...func(*Options)) (*ListObjectParentsOutput, error)
- func (c *Client) ListObjectPolicies(ctx context.Context, params *ListObjectPoliciesInput, optFns ...func(*Options)) (*ListObjectPoliciesOutput, error)
- func (c *Client) ListOutgoingTypedLinks(ctx context.Context, params *ListOutgoingTypedLinksInput, optFns ...func(*Options)) (*ListOutgoingTypedLinksOutput, error)
- func (c *Client) ListPolicyAttachments(ctx context.Context, params *ListPolicyAttachmentsInput, optFns ...func(*Options)) (*ListPolicyAttachmentsOutput, error)
- func (c *Client) ListPublishedSchemaArns(ctx context.Context, params *ListPublishedSchemaArnsInput, optFns ...func(*Options)) (*ListPublishedSchemaArnsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTypedLinkFacetAttributes(ctx context.Context, params *ListTypedLinkFacetAttributesInput, optFns ...func(*Options)) (*ListTypedLinkFacetAttributesOutput, error)
- func (c *Client) ListTypedLinkFacetNames(ctx context.Context, params *ListTypedLinkFacetNamesInput, optFns ...func(*Options)) (*ListTypedLinkFacetNamesOutput, error)
- func (c *Client) LookupPolicy(ctx context.Context, params *LookupPolicyInput, optFns ...func(*Options)) (*LookupPolicyOutput, error)
- func (c *Client) PublishSchema(ctx context.Context, params *PublishSchemaInput, optFns ...func(*Options)) (*PublishSchemaOutput, error)
- func (c *Client) PutSchemaFromJson(ctx context.Context, params *PutSchemaFromJsonInput, optFns ...func(*Options)) (*PutSchemaFromJsonOutput, error)
- func (c *Client) RemoveFacetFromObject(ctx context.Context, params *RemoveFacetFromObjectInput, optFns ...func(*Options)) (*RemoveFacetFromObjectOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateFacet(ctx context.Context, params *UpdateFacetInput, optFns ...func(*Options)) (*UpdateFacetOutput, error)
- func (c *Client) UpdateLinkAttributes(ctx context.Context, params *UpdateLinkAttributesInput, optFns ...func(*Options)) (*UpdateLinkAttributesOutput, error)
- func (c *Client) UpdateObjectAttributes(ctx context.Context, params *UpdateObjectAttributesInput, optFns ...func(*Options)) (*UpdateObjectAttributesOutput, error)
- func (c *Client) UpdateSchema(ctx context.Context, params *UpdateSchemaInput, optFns ...func(*Options)) (*UpdateSchemaOutput, error)
- func (c *Client) UpdateTypedLinkFacet(ctx context.Context, params *UpdateTypedLinkFacetInput, optFns ...func(*Options)) (*UpdateTypedLinkFacetOutput, error)
- func (c *Client) UpgradeAppliedSchema(ctx context.Context, params *UpgradeAppliedSchemaInput, optFns ...func(*Options)) (*UpgradeAppliedSchemaOutput, error)
- func (c *Client) UpgradePublishedSchema(ctx context.Context, params *UpgradePublishedSchemaInput, optFns ...func(*Options)) (*UpgradePublishedSchemaOutput, error)
- type CreateDirectoryInput
- type CreateDirectoryOutput
- type CreateFacetInput
- type CreateFacetOutput
- type CreateIndexInput
- type CreateIndexOutput
- type CreateObjectInput
- type CreateObjectOutput
- type CreateSchemaInput
- type CreateSchemaOutput
- type CreateTypedLinkFacetInput
- type CreateTypedLinkFacetOutput
- type DeleteDirectoryInput
- type DeleteDirectoryOutput
- type DeleteFacetInput
- type DeleteFacetOutput
- type DeleteObjectInput
- type DeleteObjectOutput
- type DeleteSchemaInput
- type DeleteSchemaOutput
- type DeleteTypedLinkFacetInput
- type DeleteTypedLinkFacetOutput
- type DetachFromIndexInput
- type DetachFromIndexOutput
- type DetachObjectInput
- type DetachObjectOutput
- type DetachPolicyInput
- type DetachPolicyOutput
- type DetachTypedLinkInput
- type DetachTypedLinkOutput
- type DisableDirectoryInput
- type DisableDirectoryOutput
- type EnableDirectoryInput
- type EnableDirectoryOutput
- type EndpointResolver
- type EndpointResolverFunc
- type GetAppliedSchemaVersionInput
- type GetAppliedSchemaVersionOutput
- type GetDirectoryInput
- type GetDirectoryOutput
- type GetFacetInput
- type GetFacetOutput
- type GetLinkAttributesInput
- type GetLinkAttributesOutput
- type GetObjectAttributesInput
- type GetObjectAttributesOutput
- type GetObjectInformationInput
- type GetObjectInformationOutput
- type GetSchemaAsJsonInput
- type GetSchemaAsJsonOutput
- type GetTypedLinkFacetInformationInput
- type GetTypedLinkFacetInformationOutput
- type HTTPClient
- type HTTPSignerV4
- type ListAppliedSchemaArnsInput
- type ListAppliedSchemaArnsOutput
- type ListAttachedIndicesInput
- type ListAttachedIndicesOutput
- type ListDevelopmentSchemaArnsInput
- type ListDevelopmentSchemaArnsOutput
- type ListDirectoriesInput
- type ListDirectoriesOutput
- type ListFacetAttributesInput
- type ListFacetAttributesOutput
- type ListFacetNamesInput
- type ListFacetNamesOutput
- type ListIncomingTypedLinksInput
- type ListIncomingTypedLinksOutput
- type ListIndexInput
- type ListIndexOutput
- type ListManagedSchemaArnsInput
- type ListManagedSchemaArnsOutput
- type ListObjectAttributesInput
- type ListObjectAttributesOutput
- type ListObjectChildrenInput
- type ListObjectChildrenOutput
- type ListObjectParentPathsInput
- type ListObjectParentPathsOutput
- type ListObjectParentsInput
- type ListObjectParentsOutput
- type ListObjectPoliciesInput
- type ListObjectPoliciesOutput
- type ListOutgoingTypedLinksInput
- type ListOutgoingTypedLinksOutput
- type ListPolicyAttachmentsInput
- type ListPolicyAttachmentsOutput
- type ListPublishedSchemaArnsInput
- type ListPublishedSchemaArnsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTypedLinkFacetAttributesInput
- type ListTypedLinkFacetAttributesOutput
- type ListTypedLinkFacetNamesInput
- type ListTypedLinkFacetNamesOutput
- type LookupPolicyInput
- type LookupPolicyOutput
- type Options
- type PublishSchemaInput
- type PublishSchemaOutput
- type PutSchemaFromJsonInput
- type PutSchemaFromJsonOutput
- type RemoveFacetFromObjectInput
- type RemoveFacetFromObjectOutput
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolverOptions
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateFacetInput
- type UpdateFacetOutput
- type UpdateLinkAttributesInput
- type UpdateLinkAttributesOutput
- type UpdateObjectAttributesInput
- type UpdateObjectAttributesOutput
- type UpdateSchemaInput
- type UpdateSchemaOutput
- type UpdateTypedLinkFacetInput
- type UpdateTypedLinkFacetOutput
- type UpgradeAppliedSchemaInput
- type UpgradeAppliedSchemaOutput
- type UpgradePublishedSchemaInput
- type UpgradePublishedSchemaOutput
Constants ¶
const ServiceAPIVersion = "2017-01-11"
const ServiceID = "CloudDirectory"
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
Types ¶
type AddFacetToObjectInput ¶
type AddFacetToObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. For more information, see arns. // // This member is required. DirectoryArn *string // A reference to the object you are adding the specified facet to. // // This member is required. ObjectReference *types.ObjectReference // Identifiers for the facet that you are adding to the object. See SchemaFacet for // details. // // This member is required. SchemaFacet *types.SchemaFacet // Attributes on the facet that you are adding to the object. ObjectAttributeList []*types.AttributeKeyAndValue }
type AddFacetToObjectOutput ¶
type AddFacetToObjectOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ApplySchemaInput ¶
type ApplySchemaInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory into which // the schema is copied. For more information, see arns. // // This member is required. DirectoryArn *string // Published schema Amazon Resource Name (ARN) that needs to be copied. For more // information, see arns. // // This member is required. PublishedSchemaArn *string }
type ApplySchemaOutput ¶
type ApplySchemaOutput struct { // The applied schema ARN that is associated with the copied schema in the // Directory. You can use this ARN to describe the schema information applied on // this directory. For more information, see arns. AppliedSchemaArn *string // The ARN that is associated with the Directory. For more information, see arns. DirectoryArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AttachObjectInput ¶
type AttachObjectInput struct { // The child object reference to be attached to the object. // // This member is required. ChildReference *types.ObjectReference // Amazon Resource Name (ARN) that is associated with the Directory where both // objects reside. For more information, see arns. // // This member is required. DirectoryArn *string // The link name with which the child object is attached to the parent. // // This member is required. LinkName *string // The parent object reference. // // This member is required. ParentReference *types.ObjectReference }
type AttachObjectOutput ¶
type AttachObjectOutput struct { // The attached ObjectIdentifier, which is the child ObjectIdentifier. AttachedObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AttachPolicyInput ¶
type AttachPolicyInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where both // objects reside. For more information, see arns. // // This member is required. DirectoryArn *string // The reference that identifies the object to which the policy will be attached. // // This member is required. ObjectReference *types.ObjectReference // The reference that is associated with the policy object. // // This member is required. PolicyReference *types.ObjectReference }
type AttachPolicyOutput ¶
type AttachPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AttachToIndexInput ¶
type AttachToIndexInput struct { // The Amazon Resource Name (ARN) of the directory where the object and index // exist. // // This member is required. DirectoryArn *string // A reference to the index that you are attaching the object to. // // This member is required. IndexReference *types.ObjectReference // A reference to the object that you are attaching to the index. // // This member is required. TargetReference *types.ObjectReference }
type AttachToIndexOutput ¶
type AttachToIndexOutput struct { // The ObjectIdentifier of the object that was attached to the index. AttachedObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type AttachTypedLinkInput ¶
type AttachTypedLinkInput struct { // A set of attributes that are associated with the typed link. // // This member is required. Attributes []*types.AttributeNameAndValue // The Amazon Resource Name (ARN) of the directory where you want to attach the // typed link. // // This member is required. DirectoryArn *string // Identifies the source object that the typed link will attach to. // // This member is required. SourceObjectReference *types.ObjectReference // Identifies the target object that the typed link will attach to. // // This member is required. TargetObjectReference *types.ObjectReference // Identifies the typed link facet that is associated with the typed link. // // This member is required. TypedLinkFacet *types.TypedLinkSchemaAndFacetName }
type AttachTypedLinkOutput ¶
type AttachTypedLinkOutput struct { // Returns a typed link specifier as output. TypedLinkSpecifier *types.TypedLinkSpecifier // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchReadInput ¶
type BatchReadInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory. For more // information, see arns. // // This member is required. DirectoryArn *string // A list of operations that are part of the batch. // // This member is required. Operations []*types.BatchReadOperation // 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 types.ConsistencyLevel }
type BatchReadOutput ¶
type BatchReadOutput struct { // A list of all the responses for each batch read. Responses []*types.BatchReadOperationResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type BatchWriteInput ¶
type BatchWriteInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory. For more // information, see arns. // // This member is required. DirectoryArn *string // A list of operations that are part of the batch. // // This member is required. Operations []*types.BatchWriteOperation }
type BatchWriteOutput ¶
type BatchWriteOutput struct { // A list of all the responses for each batch write. Responses []*types.BatchWriteOperationResponse // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for Amazon CloudDirectory.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) AddFacetToObject ¶
func (c *Client) AddFacetToObject(ctx context.Context, params *AddFacetToObjectInput, optFns ...func(*Options)) (*AddFacetToObjectOutput, error)
Adds a new Facet to an object. An object can have more than one facet applied on it.
func (*Client) ApplySchema ¶
func (c *Client) ApplySchema(ctx context.Context, params *ApplySchemaInput, optFns ...func(*Options)) (*ApplySchemaOutput, error)
Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
func (*Client) AttachObject ¶
func (c *Client) AttachObject(ctx context.Context, params *AttachObjectInput, optFns ...func(*Options)) (*AttachObjectOutput, error)
Attaches an existing object to another object. An object can be accessed in two ways:
Using the path
Using ObjectIdentifier
func (*Client) AttachPolicy ¶
func (c *Client) AttachPolicy(ctx context.Context, params *AttachPolicyInput, optFns ...func(*Options)) (*AttachPolicyOutput, error)
Attaches a policy object to a regular object. An object can have a limited number of attached policies.
func (*Client) AttachToIndex ¶
func (c *Client) AttachToIndex(ctx context.Context, params *AttachToIndexInput, optFns ...func(*Options)) (*AttachToIndexOutput, error)
Attaches the specified object to the specified index.
func (*Client) AttachTypedLink ¶
func (c *Client) AttachTypedLink(ctx context.Context, params *AttachTypedLinkInput, optFns ...func(*Options)) (*AttachTypedLinkOutput, error)
Attaches a typed link to a specified source and target object. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) BatchRead ¶
func (c *Client) BatchRead(ctx context.Context, params *BatchReadInput, optFns ...func(*Options)) (*BatchReadOutput, error)
Performs all the read operations in a batch.
func (*Client) BatchWrite ¶
func (c *Client) BatchWrite(ctx context.Context, params *BatchWriteInput, optFns ...func(*Options)) (*BatchWriteOutput, error)
Performs all the write operations in a batch. Either all the operations succeed or none.
func (*Client) CreateDirectory ¶
func (c *Client) CreateDirectory(ctx context.Context, params *CreateDirectoryInput, optFns ...func(*Options)) (*CreateDirectoryOutput, error)
Creates a Directory by copying the published schema into the directory. A directory cannot be created without a schema. You can also quickly create a directory using a managed schema, called the QuickStartSchema. For more information, see Managed Schema (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_managed.html) in the Amazon Cloud Directory Developer Guide.
func (*Client) CreateFacet ¶
func (c *Client) CreateFacet(ctx context.Context, params *CreateFacetInput, optFns ...func(*Options)) (*CreateFacetOutput, error)
Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
func (*Client) CreateIndex ¶
func (c *Client) CreateIndex(ctx context.Context, params *CreateIndexInput, optFns ...func(*Options)) (*CreateIndexOutput, error)
Creates an index object. See Indexing and search (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/indexing_search.html) for more information.
func (*Client) CreateObject ¶
func (c *Client) CreateObject(ctx context.Context, params *CreateObjectInput, optFns ...func(*Options)) (*CreateObjectOutput, error)
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.
func (*Client) CreateSchema ¶
func (c *Client) CreateSchema(ctx context.Context, params *CreateSchemaInput, optFns ...func(*Options)) (*CreateSchemaOutput, error)
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.
func (*Client) CreateTypedLinkFacet ¶
func (c *Client) CreateTypedLinkFacet(ctx context.Context, params *CreateTypedLinkFacetInput, optFns ...func(*Options)) (*CreateTypedLinkFacetOutput, error)
Creates a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) DeleteDirectory ¶
func (c *Client) DeleteDirectory(ctx context.Context, params *DeleteDirectoryInput, optFns ...func(*Options)) (*DeleteDirectoryOutput, error)
Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
func (*Client) DeleteFacet ¶
func (c *Client) DeleteFacet(ctx context.Context, params *DeleteFacetInput, optFns ...func(*Options)) (*DeleteFacetOutput, error)
Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
func (*Client) DeleteObject ¶
func (c *Client) DeleteObject(ctx context.Context, params *DeleteObjectInput, optFns ...func(*Options)) (*DeleteObjectOutput, error)
Deletes an object and its associated attributes. Only objects with no children and no parents can be deleted. The maximum number of attributes that can be deleted during an object deletion is 30. For more information, see Amazon Cloud Directory Limits (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html).
func (*Client) DeleteSchema ¶
func (c *Client) DeleteSchema(ctx context.Context, params *DeleteSchemaInput, optFns ...func(*Options)) (*DeleteSchemaOutput, error)
Deletes a given schema. Schemas in a development and published state can only be deleted.
func (*Client) DeleteTypedLinkFacet ¶
func (c *Client) DeleteTypedLinkFacet(ctx context.Context, params *DeleteTypedLinkFacetInput, optFns ...func(*Options)) (*DeleteTypedLinkFacetOutput, error)
Deletes a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) DetachFromIndex ¶
func (c *Client) DetachFromIndex(ctx context.Context, params *DetachFromIndexInput, optFns ...func(*Options)) (*DetachFromIndexOutput, error)
Detaches the specified object from the specified index.
func (*Client) DetachObject ¶
func (c *Client) DetachObject(ctx context.Context, params *DetachObjectInput, optFns ...func(*Options)) (*DetachObjectOutput, error)
Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
func (*Client) DetachPolicy ¶
func (c *Client) DetachPolicy(ctx context.Context, params *DetachPolicyInput, optFns ...func(*Options)) (*DetachPolicyOutput, error)
Detaches a policy from an object.
func (*Client) DetachTypedLink ¶
func (c *Client) DetachTypedLink(ctx context.Context, params *DetachTypedLinkInput, optFns ...func(*Options)) (*DetachTypedLinkOutput, error)
Detaches a typed link from a specified source and target object. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) DisableDirectory ¶
func (c *Client) DisableDirectory(ctx context.Context, params *DisableDirectoryInput, optFns ...func(*Options)) (*DisableDirectoryOutput, error)
Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
func (*Client) EnableDirectory ¶
func (c *Client) EnableDirectory(ctx context.Context, params *EnableDirectoryInput, optFns ...func(*Options)) (*EnableDirectoryOutput, error)
Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
func (*Client) GetAppliedSchemaVersion ¶
func (c *Client) GetAppliedSchemaVersion(ctx context.Context, params *GetAppliedSchemaVersionInput, optFns ...func(*Options)) (*GetAppliedSchemaVersionOutput, error)
Returns current applied schema version ARN, including the minor version in use.
func (*Client) GetDirectory ¶
func (c *Client) GetDirectory(ctx context.Context, params *GetDirectoryInput, optFns ...func(*Options)) (*GetDirectoryOutput, error)
Retrieves metadata about a directory.
func (*Client) GetFacet ¶
func (c *Client) GetFacet(ctx context.Context, params *GetFacetInput, optFns ...func(*Options)) (*GetFacetOutput, error)
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.
func (*Client) GetLinkAttributes ¶
func (c *Client) GetLinkAttributes(ctx context.Context, params *GetLinkAttributesInput, optFns ...func(*Options)) (*GetLinkAttributesOutput, error)
Retrieves attributes that are associated with a typed link.
func (*Client) GetObjectAttributes ¶
func (c *Client) GetObjectAttributes(ctx context.Context, params *GetObjectAttributesInput, optFns ...func(*Options)) (*GetObjectAttributesOutput, error)
Retrieves attributes within a facet that are associated with an object.
func (*Client) GetObjectInformation ¶
func (c *Client) GetObjectInformation(ctx context.Context, params *GetObjectInformationInput, optFns ...func(*Options)) (*GetObjectInformationOutput, error)
Retrieves metadata about an object.
func (*Client) GetSchemaAsJson ¶
func (c *Client) GetSchemaAsJson(ctx context.Context, params *GetSchemaAsJsonInput, optFns ...func(*Options)) (*GetSchemaAsJsonOutput, error)
Retrieves a JSON representation of the schema. See JSON Schema Format (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) for more information.
func (*Client) GetTypedLinkFacetInformation ¶
func (c *Client) GetTypedLinkFacetInformation(ctx context.Context, params *GetTypedLinkFacetInformationInput, optFns ...func(*Options)) (*GetTypedLinkFacetInformationOutput, error)
Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) ListAppliedSchemaArns ¶
func (c *Client) ListAppliedSchemaArns(ctx context.Context, params *ListAppliedSchemaArnsInput, optFns ...func(*Options)) (*ListAppliedSchemaArnsOutput, error)
Lists schema major versions applied to a directory. If SchemaArn is provided, lists the minor version.
func (*Client) ListAttachedIndices ¶
func (c *Client) ListAttachedIndices(ctx context.Context, params *ListAttachedIndicesInput, optFns ...func(*Options)) (*ListAttachedIndicesOutput, error)
Lists indices attached to the specified object.
func (*Client) ListDevelopmentSchemaArns ¶
func (c *Client) ListDevelopmentSchemaArns(ctx context.Context, params *ListDevelopmentSchemaArnsInput, optFns ...func(*Options)) (*ListDevelopmentSchemaArnsOutput, error)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
func (*Client) ListDirectories ¶
func (c *Client) ListDirectories(ctx context.Context, params *ListDirectoriesInput, optFns ...func(*Options)) (*ListDirectoriesOutput, error)
Lists directories created within an account.
func (*Client) ListFacetAttributes ¶
func (c *Client) ListFacetAttributes(ctx context.Context, params *ListFacetAttributesInput, optFns ...func(*Options)) (*ListFacetAttributesOutput, error)
Retrieves attributes attached to the facet.
func (*Client) ListFacetNames ¶
func (c *Client) ListFacetNames(ctx context.Context, params *ListFacetNamesInput, optFns ...func(*Options)) (*ListFacetNamesOutput, error)
Retrieves the names of facets that exist in a schema.
func (*Client) ListIncomingTypedLinks ¶
func (c *Client) ListIncomingTypedLinks(ctx context.Context, params *ListIncomingTypedLinksInput, optFns ...func(*Options)) (*ListIncomingTypedLinksOutput, error)
Returns a paginated list of all the incoming TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) ListIndex ¶
func (c *Client) ListIndex(ctx context.Context, params *ListIndexInput, optFns ...func(*Options)) (*ListIndexOutput, error)
Lists objects attached to the specified index.
func (*Client) ListManagedSchemaArns ¶
func (c *Client) ListManagedSchemaArns(ctx context.Context, params *ListManagedSchemaArnsInput, optFns ...func(*Options)) (*ListManagedSchemaArnsOutput, error)
Lists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.
func (*Client) ListObjectAttributes ¶
func (c *Client) ListObjectAttributes(ctx context.Context, params *ListObjectAttributesInput, optFns ...func(*Options)) (*ListObjectAttributesOutput, error)
Lists all attributes that are associated with an object.
func (*Client) ListObjectChildren ¶
func (c *Client) ListObjectChildren(ctx context.Context, params *ListObjectChildrenInput, optFns ...func(*Options)) (*ListObjectChildrenOutput, error)
Returns a paginated list of child objects that are associated with a given object.
func (*Client) ListObjectParentPaths ¶
func (c *Client) ListObjectParentPaths(ctx context.Context, params *ListObjectParentPathsInput, optFns ...func(*Options)) (*ListObjectParentPathsOutput, error)
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects. For more information about objects, see Directory Structure (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directorystructure.html). Use this API to evaluate all parents for an object. The call returns all objects from the root of the directory up to the requested object. The API returns the number of paths based on user-defined MaxResults, in case there are multiple paths to the parent. The order of the paths and nodes returned is consistent among multiple API calls unless the objects are deleted or moved. Paths not leading to the directory root are ignored from the target object.
func (*Client) ListObjectParents ¶
func (c *Client) ListObjectParents(ctx context.Context, params *ListObjectParentsInput, optFns ...func(*Options)) (*ListObjectParentsOutput, error)
Lists parent objects that are associated with a given object in pagination fashion.
func (*Client) ListObjectPolicies ¶
func (c *Client) ListObjectPolicies(ctx context.Context, params *ListObjectPoliciesInput, optFns ...func(*Options)) (*ListObjectPoliciesOutput, error)
Returns policies attached to an object in pagination fashion.
func (*Client) ListOutgoingTypedLinks ¶
func (c *Client) ListOutgoingTypedLinks(ctx context.Context, params *ListOutgoingTypedLinksInput, optFns ...func(*Options)) (*ListOutgoingTypedLinksOutput, error)
Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object. It also supports filtering by typed link facet and identity attributes. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) ListPolicyAttachments ¶
func (c *Client) ListPolicyAttachments(ctx context.Context, params *ListPolicyAttachmentsInput, optFns ...func(*Options)) (*ListPolicyAttachmentsOutput, error)
Returns all of the ObjectIdentifiers to which a given policy is attached.
func (*Client) ListPublishedSchemaArns ¶
func (c *Client) ListPublishedSchemaArns(ctx context.Context, params *ListPublishedSchemaArnsInput, optFns ...func(*Options)) (*ListPublishedSchemaArnsOutput, error)
Lists the major version families of each published schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
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.
func (*Client) ListTypedLinkFacetAttributes ¶
func (c *Client) ListTypedLinkFacetAttributes(ctx context.Context, params *ListTypedLinkFacetAttributesInput, optFns ...func(*Options)) (*ListTypedLinkFacetAttributesOutput, error)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) ListTypedLinkFacetNames ¶
func (c *Client) ListTypedLinkFacetNames(ctx context.Context, params *ListTypedLinkFacetNamesInput, optFns ...func(*Options)) (*ListTypedLinkFacetNamesOutput, error)
Returns a paginated list of TypedLink facet names for a particular schema. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) LookupPolicy ¶
func (c *Client) LookupPolicy(ctx context.Context, params *LookupPolicyInput, optFns ...func(*Options)) (*LookupPolicyOutput, error)
Lists all policies from the root of the Directory to the object specified. If there are no policies present, an empty list is returned. If policies are present, and if some objects don't have the policies attached, it returns the ObjectIdentifier for such objects. If policies are present, it returns ObjectIdentifier, policyId, and policyType. Paths that don't lead to the root from the target object are ignored. For more information, see Policies (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies).
func (*Client) PublishSchema ¶
func (c *Client) PublishSchema(ctx context.Context, params *PublishSchemaInput, optFns ...func(*Options)) (*PublishSchemaOutput, error)
Publishes a development schema with a major version and a recommended minor version.
func (*Client) PutSchemaFromJson ¶
func (c *Client) PutSchemaFromJson(ctx context.Context, params *PutSchemaFromJsonInput, optFns ...func(*Options)) (*PutSchemaFromJsonOutput, error)
Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/schemas_jsonformat.html#schemas_json) for more information.
func (*Client) RemoveFacetFromObject ¶
func (c *Client) RemoveFacetFromObject(ctx context.Context, params *RemoveFacetFromObjectInput, optFns ...func(*Options)) (*RemoveFacetFromObjectOutput, error)
Removes the specified facet from the specified object.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
An API operation for adding tags to a resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
An API operation for removing tags from a resource.
func (*Client) UpdateFacet ¶
func (c *Client) UpdateFacet(ctx context.Context, params *UpdateFacetInput, optFns ...func(*Options)) (*UpdateFacetOutput, error)
Does the following:
Adds new Attributes, Rules, or ObjectTypes.
*
Updates existing Attributes, Rules, or ObjectTypes.
- Deletes existing
Attributes, Rules, or ObjectTypes.
func (*Client) UpdateLinkAttributes ¶
func (c *Client) UpdateLinkAttributes(ctx context.Context, params *UpdateLinkAttributesInput, optFns ...func(*Options)) (*UpdateLinkAttributesOutput, error)
Updates a given typed link’s attributes. Attributes to be updated must not contribute to the typed link’s identity, as defined by its IdentityAttributeOrder.
func (*Client) UpdateObjectAttributes ¶
func (c *Client) UpdateObjectAttributes(ctx context.Context, params *UpdateObjectAttributesInput, optFns ...func(*Options)) (*UpdateObjectAttributesOutput, error)
Updates a given object's attributes.
func (*Client) UpdateSchema ¶
func (c *Client) UpdateSchema(ctx context.Context, params *UpdateSchemaInput, optFns ...func(*Options)) (*UpdateSchemaOutput, error)
Updates the schema name with a new name. Only development schema names can be updated.
func (*Client) UpdateTypedLinkFacet ¶
func (c *Client) UpdateTypedLinkFacet(ctx context.Context, params *UpdateTypedLinkFacetInput, optFns ...func(*Options)) (*UpdateTypedLinkFacetOutput, error)
Updates a TypedLinkFacet. For more information, see Typed Links (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink).
func (*Client) UpgradeAppliedSchema ¶
func (c *Client) UpgradeAppliedSchema(ctx context.Context, params *UpgradeAppliedSchemaInput, optFns ...func(*Options)) (*UpgradeAppliedSchemaOutput, error)
Upgrades a single directory in-place using the PublishedSchemaArn with schema updates found in MinorVersion. Backwards-compatible minor version upgrades are instantaneously available for readers on all objects in the directory. Note: This is a synchronous API call and upgrades only one schema on a given directory per call. To upgrade multiple directories from one schema, you would need to call this API on each directory.
func (*Client) UpgradePublishedSchema ¶
func (c *Client) UpgradePublishedSchema(ctx context.Context, params *UpgradePublishedSchemaInput, optFns ...func(*Options)) (*UpgradePublishedSchemaOutput, error)
Upgrades a published schema under a new minor version revision using the current contents of DevelopmentSchemaArn.
type CreateDirectoryInput ¶
type CreateDirectoryInput struct { // The name of the Directory. Should be unique per account, per region. // // This member is required. Name *string // The Amazon Resource Name (ARN) of the published schema that will be copied into // the data Directory. For more information, see arns. // // This member is required. SchemaArn *string }
type CreateDirectoryOutput ¶
type CreateDirectoryOutput struct { // The ARN of the published schema in the Directory. Once a published schema is // copied into the directory, it has its own ARN, which is referred to applied // schema ARN. For more information, see arns. // // This member is required. AppliedSchemaArn *string // The ARN that is associated with the Directory. For more information, see arns. // // This member is required. DirectoryArn *string // The name of the Directory. // // This member is required. Name *string // The root object node of the created directory. // // This member is required. ObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateFacetInput ¶
type CreateFacetInput struct { // The name of the Facet, which is unique for a given schema. // // This member is required. Name *string // The schema ARN in which the new Facet will be created. For more information, see // arns. // // This member is required. SchemaArn *string // The attributes that are associated with the Facet. Attributes []*types.FacetAttribute // There are two different styles that you can define on any given facet, Static // and Dynamic. For static facets, all attributes must be defined in the schema. // For dynamic facets, attributes can be defined during data plane operations. FacetStyle types.FacetStyle // Specifies whether a given object created from this facet is of type node, leaf // node, policy or index. // // * Node: Can have multiple children but one parent. // // // * Leaf node: Cannot have children but can have multiple parents. // // * Policy: // Allows you to store a policy document and policy type. For more information, see // Policies // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). // // // * Index: Can be created with the Index API. ObjectType types.ObjectType }
type CreateFacetOutput ¶
type CreateFacetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateIndexInput ¶
type CreateIndexInput struct { // The ARN of the directory where the index should be created. // // This member is required. DirectoryArn *string // Indicates whether the attribute that is being indexed has unique values or not. // // This member is required. IsUnique *bool // Specifies the attributes that should be indexed on. Currently only a single // attribute is supported. // // This member is required. OrderedIndexedAttributeList []*types.AttributeKey // The name of the link between the parent object and the index object. LinkName *string // A reference to the parent object that contains the index object. ParentReference *types.ObjectReference }
type CreateIndexOutput ¶
type CreateIndexOutput struct { // The ObjectIdentifier of the index created by this operation. ObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateObjectInput ¶
type CreateObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory in which // the object will be created. For more information, see arns. // // This member is required. DirectoryArn *string // A list of schema facets to be associated with the object. Do not provide minor // version components. See SchemaFacet for details. // // This member is required. SchemaFacets []*types.SchemaFacet // The name of link that is used to attach this object to a parent. LinkName *string // The attribute map whose attribute ARN contains the key and attribute value as // the map value. ObjectAttributeList []*types.AttributeKeyAndValue // If specified, the parent reference to which this object will be attached. ParentReference *types.ObjectReference }
type CreateObjectOutput ¶
type CreateObjectOutput struct { // The identifier that is associated with the object. ObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateSchemaInput ¶
type CreateSchemaInput struct { // The name that is associated with the schema. This is unique to each account and // in each region. // // This member is required. Name *string }
type CreateSchemaOutput ¶
type CreateSchemaOutput struct { // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. SchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateTypedLinkFacetInput ¶
type CreateTypedLinkFacetInput struct { // Facet structure that is associated with the typed link facet. // // This member is required. Facet *types.TypedLinkFacet // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. // // This member is required. SchemaArn *string }
type CreateTypedLinkFacetOutput ¶
type CreateTypedLinkFacetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteDirectoryInput ¶
type DeleteDirectoryInput struct { // The ARN of the directory to delete. // // This member is required. DirectoryArn *string }
type DeleteDirectoryOutput ¶
type DeleteDirectoryOutput struct { // The ARN of the deleted directory. // // This member is required. DirectoryArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteFacetInput ¶
type DeleteFacetInput struct { // The name of the facet to delete. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the Facet. For more // information, see arns. // // This member is required. SchemaArn *string }
type DeleteFacetOutput ¶
type DeleteFacetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteObjectInput ¶
type DeleteObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. For more information, see arns. // // This member is required. DirectoryArn *string // A reference that identifies the object. // // This member is required. ObjectReference *types.ObjectReference }
type DeleteObjectOutput ¶
type DeleteObjectOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteSchemaInput ¶
type DeleteSchemaInput struct { // The Amazon Resource Name (ARN) of the development schema. For more information, // see arns. // // This member is required. SchemaArn *string }
type DeleteSchemaOutput ¶
type DeleteSchemaOutput struct { // The input ARN that is returned as part of the response. For more information, // see arns. SchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteTypedLinkFacetInput ¶
type DeleteTypedLinkFacetInput struct { // The unique name of the typed link facet. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. // // This member is required. SchemaArn *string }
type DeleteTypedLinkFacetOutput ¶
type DeleteTypedLinkFacetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetachFromIndexInput ¶
type DetachFromIndexInput struct { // The Amazon Resource Name (ARN) of the directory the index and object exist in. // // This member is required. DirectoryArn *string // A reference to the index object. // // This member is required. IndexReference *types.ObjectReference // A reference to the object being detached from the index. // // This member is required. TargetReference *types.ObjectReference }
type DetachFromIndexOutput ¶
type DetachFromIndexOutput struct { // The ObjectIdentifier of the object that was detached from the index. DetachedObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetachObjectInput ¶
type DetachObjectInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where // objects reside. For more information, see arns. // // This member is required. DirectoryArn *string // The link name associated with the object that needs to be detached. // // This member is required. LinkName *string // The parent reference from which the object with the specified link name is // detached. // // This member is required. ParentReference *types.ObjectReference }
type DetachObjectOutput ¶
type DetachObjectOutput struct { // The ObjectIdentifier that was detached from the object. DetachedObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetachPolicyInput ¶
type DetachPolicyInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where both // objects reside. For more information, see arns. // // This member is required. DirectoryArn *string // Reference that identifies the object whose policy object will be detached. // // This member is required. ObjectReference *types.ObjectReference // Reference that identifies the policy object. // // This member is required. PolicyReference *types.ObjectReference }
type DetachPolicyOutput ¶
type DetachPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DetachTypedLinkInput ¶
type DetachTypedLinkInput struct { // The Amazon Resource Name (ARN) of the directory where you want to detach the // typed link. // // This member is required. DirectoryArn *string // Used to accept a typed link specifier as input. // // This member is required. TypedLinkSpecifier *types.TypedLinkSpecifier }
type DetachTypedLinkOutput ¶
type DetachTypedLinkOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DisableDirectoryInput ¶
type DisableDirectoryInput struct { // The ARN of the directory to disable. // // This member is required. DirectoryArn *string }
type DisableDirectoryOutput ¶
type DisableDirectoryOutput struct { // The ARN of the directory that has been disabled. // // This member is required. DirectoryArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EnableDirectoryInput ¶
type EnableDirectoryInput struct { // The ARN of the directory to enable. // // This member is required. DirectoryArn *string }
type EnableDirectoryOutput ¶
type EnableDirectoryOutput struct { // The ARN of the enabled directory. // // This member is required. DirectoryArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type GetAppliedSchemaVersionInput ¶
type GetAppliedSchemaVersionInput struct { // The ARN of the applied schema. // // This member is required. SchemaArn *string }
type GetAppliedSchemaVersionOutput ¶
type GetAppliedSchemaVersionOutput struct { // Current applied schema ARN, including the minor version in use if one was // provided. AppliedSchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetDirectoryInput ¶
type GetDirectoryInput struct { // The ARN of the directory. // // This member is required. DirectoryArn *string }
type GetDirectoryOutput ¶
type GetDirectoryOutput struct { // Metadata about the directory. // // This member is required. Directory *types.Directory // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetFacetInput ¶
type GetFacetInput struct { // The name of the facet to retrieve. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the Facet. For more // information, see arns. // // This member is required. SchemaArn *string }
type GetFacetOutput ¶
type GetFacetOutput struct { // The Facet structure that is associated with the facet. Facet *types.Facet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetLinkAttributesInput ¶
type GetLinkAttributesInput struct { // A list of attribute names whose values will be retrieved. // // This member is required. AttributeNames []*string // The Amazon Resource Name (ARN) that is associated with the Directory where the // typed link resides. For more information, see arns or Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). // // This member is required. DirectoryArn *string // Allows a typed link specifier to be accepted as input. // // This member is required. TypedLinkSpecifier *types.TypedLinkSpecifier // The consistency level at which to retrieve the attributes on a typed link. ConsistencyLevel types.ConsistencyLevel }
type GetLinkAttributesOutput ¶
type GetLinkAttributesOutput struct { // The attributes that are associated with the typed link. Attributes []*types.AttributeKeyAndValue // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetObjectAttributesInput ¶
type GetObjectAttributesInput struct { // List of attribute names whose values will be retrieved. // // This member is required. AttributeNames []*string // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. // // This member is required. DirectoryArn *string // Reference that identifies the object whose attributes will be retrieved. // // This member is required. ObjectReference *types.ObjectReference // Identifier for the facet whose attributes will be retrieved. See SchemaFacet for // details. // // This member is required. SchemaFacet *types.SchemaFacet // The consistency level at which to retrieve the attributes on an object. ConsistencyLevel types.ConsistencyLevel }
type GetObjectAttributesOutput ¶
type GetObjectAttributesOutput struct { // The attributes that are associated with the object. Attributes []*types.AttributeKeyAndValue // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetObjectInformationInput ¶
type GetObjectInformationInput struct { // The ARN of the directory being retrieved. // // This member is required. DirectoryArn *string // A reference to the object. // // This member is required. ObjectReference *types.ObjectReference // The consistency level at which to retrieve the object information. ConsistencyLevel types.ConsistencyLevel }
type GetObjectInformationOutput ¶
type GetObjectInformationOutput struct { // The ObjectIdentifier of the specified object. ObjectIdentifier *string // The facets attached to the specified object. Although the response does not // include minor version information, the most recently applied minor version of // each Facet is in effect. See GetAppliedSchemaVersion for details. SchemaFacets []*types.SchemaFacet // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetSchemaAsJsonInput ¶
type GetSchemaAsJsonInput struct { // The ARN of the schema to retrieve. // // This member is required. SchemaArn *string }
type GetSchemaAsJsonOutput ¶
type GetSchemaAsJsonOutput struct { // The JSON representation of the schema document. Document *string // The name of the retrieved schema. Name *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type GetTypedLinkFacetInformationInput ¶
type GetTypedLinkFacetInformationInput struct { // The unique name of the typed link facet. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. // // This member is required. SchemaArn *string }
type GetTypedLinkFacetInformationOutput ¶
type GetTypedLinkFacetInformationOutput struct { // The order of identity attributes for the facet, from most significant to least // significant. The ability to filter typed links considers the order that the // attributes are defined on the typed link facet. When providing ranges to typed // link selection, any inexact ranges must be specified at the end. Any attributes // that do not have a range specified are presumed to match the entire range. // Filters are interpreted in the order of the attributes on the typed link facet, // not the order in which they are supplied to any API calls. For more information // about identity attributes, see Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). IdentityAttributeOrder []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListAppliedSchemaArnsInput ¶
type ListAppliedSchemaArnsInput struct { // The ARN of the directory you are listing. // // This member is required. DirectoryArn *string // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string // The response for ListAppliedSchemaArns when this parameter is used will list all // minor version ARNs for a major version. SchemaArn *string }
type ListAppliedSchemaArnsOutput ¶
type ListAppliedSchemaArnsOutput struct { // The pagination token. NextToken *string // The ARNs of schemas that are applied to the directory. SchemaArns []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListAttachedIndicesInput ¶
type ListAttachedIndicesInput struct { // The ARN of the directory. // // This member is required. DirectoryArn *string // A reference to the object that has indices attached. // // This member is required. TargetReference *types.ObjectReference // The consistency level to use for this operation. ConsistencyLevel types.ConsistencyLevel // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListAttachedIndicesOutput ¶
type ListAttachedIndicesOutput struct { // The indices attached to the specified object. IndexAttachments []*types.IndexAttachment // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDevelopmentSchemaArnsInput ¶
type ListDevelopmentSchemaArnsInput struct { // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListDevelopmentSchemaArnsOutput ¶
type ListDevelopmentSchemaArnsOutput struct { // The pagination token. NextToken *string // The ARNs of retrieved development schemas. SchemaArns []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListDirectoriesInput ¶
type ListDirectoriesInput struct { // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string // The state of the directories in the list. Can be either Enabled, Disabled, or // Deleted. State types.DirectoryState }
type ListDirectoriesOutput ¶
type ListDirectoriesOutput struct { // Lists all directories that are associated with your account in pagination // fashion. // // This member is required. Directories []*types.Directory // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListFacetAttributesInput ¶
type ListFacetAttributesInput struct { // The name of the facet whose attributes will be retrieved. // // This member is required. Name *string // The ARN of the schema where the facet resides. // // This member is required. SchemaArn *string // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListFacetAttributesOutput ¶
type ListFacetAttributesOutput struct { // The attributes attached to the facet. Attributes []*types.FacetAttribute // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListFacetNamesInput ¶
type ListFacetNamesInput struct { // The Amazon Resource Name (ARN) to retrieve facet names from. // // This member is required. SchemaArn *string // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListFacetNamesOutput ¶
type ListFacetNamesOutput struct { // The names of facets that exist within the schema. FacetNames []*string // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListIncomingTypedLinksInput ¶
type ListIncomingTypedLinksInput struct { // The Amazon Resource Name (ARN) of the directory where you want to list the typed // links. // // This member is required. DirectoryArn *string // Reference that identifies the object whose attributes will be listed. // // This member is required. ObjectReference *types.ObjectReference // The consistency level to execute the request at. ConsistencyLevel types.ConsistencyLevel // Provides range filters for multiple attributes. When providing ranges to typed // link selection, any inexact ranges must be specified at the end. Any attributes // that do not have a range specified are presumed to match the entire range. FilterAttributeRanges []*types.TypedLinkAttributeRange // Filters are interpreted in the order of the attributes on the typed link facet, // not the order in which they are supplied to any API calls. FilterTypedLink *types.TypedLinkSchemaAndFacetName // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListIncomingTypedLinksOutput ¶
type ListIncomingTypedLinksOutput struct { // Returns one or more typed link specifiers as output. LinkSpecifiers []*types.TypedLinkSpecifier // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListIndexInput ¶
type ListIndexInput struct { // The ARN of the directory that the index exists in. // // This member is required. DirectoryArn *string // The reference to the index to list. // // This member is required. IndexReference *types.ObjectReference // The consistency level to execute the request at. ConsistencyLevel types.ConsistencyLevel // The maximum number of objects in a single page to retrieve from the index during // a request. For more information, see Amazon Cloud Directory Limits // (http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html). MaxResults *int32 // The pagination token. NextToken *string // Specifies the ranges of indexed values that you want to query. RangesOnIndexedValues []*types.ObjectAttributeRange }
type ListIndexOutput ¶
type ListIndexOutput struct { // The objects and indexed values attached to the index. IndexAttachments []*types.IndexAttachment // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListManagedSchemaArnsInput ¶
type ListManagedSchemaArnsInput struct { // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string // The response for ListManagedSchemaArns. When this parameter is used, all minor // version ARNs for a major version are listed. SchemaArn *string }
type ListManagedSchemaArnsOutput ¶
type ListManagedSchemaArnsOutput struct { // The pagination token. NextToken *string // The ARNs for all AWS managed schemas. SchemaArns []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListObjectAttributesInput ¶
type ListObjectAttributesInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. For more information, see arns. // // This member is required. DirectoryArn *string // The reference that identifies the object whose attributes will be listed. // // This member is required. ObjectReference *types.ObjectReference // 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 types.ConsistencyLevel // Used to filter the list of object attributes that are associated with a certain // facet. FacetFilter *types.SchemaFacet // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string }
type ListObjectAttributesOutput ¶
type ListObjectAttributesOutput struct { // Attributes map that is associated with the object. AttributeArn is the key, and // attribute value is the value. Attributes []*types.AttributeKeyAndValue // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListObjectChildrenInput ¶
type ListObjectChildrenInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. For more information, see arns. // // This member is required. DirectoryArn *string // The reference that identifies the object for which child objects are being // listed. // // This member is required. ObjectReference *types.ObjectReference // 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 types.ConsistencyLevel // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string }
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 // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListObjectParentPathsInput ¶
type ListObjectParentPathsInput struct { // The ARN of the directory to which the parent path applies. // // This member is required. DirectoryArn *string // The reference that identifies the object whose parent paths are listed. // // This member is required. ObjectReference *types.ObjectReference // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string }
type ListObjectParentPathsOutput ¶
type ListObjectParentPathsOutput struct { // The pagination token. NextToken *string // Returns the path to the ObjectIdentifiers that are associated with the // directory. PathToObjectIdentifiersList []*types.PathToObjectIdentifiers // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListObjectParentsInput ¶
type ListObjectParentsInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. For more information, see arns. // // This member is required. DirectoryArn *string // The reference that identifies the object for which parent objects are being // listed. // // This member is required. ObjectReference *types.ObjectReference // 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 types.ConsistencyLevel // When set to True, returns all ListObjectParentsResponse$ParentLinks. There could // be multiple links between a parent-child pair. IncludeAllLinksToEachParent *bool // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string }
type ListObjectParentsOutput ¶
type ListObjectParentsOutput struct { // The pagination token. NextToken *string // Returns a list of parent reference and LinkName Tuples. ParentLinks []*types.ObjectIdentifierAndLinkNameTuple // The parent structure, which is a map with key as the ObjectIdentifier and // LinkName as the value. Parents map[string]*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListObjectPoliciesInput ¶
type ListObjectPoliciesInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where // objects reside. For more information, see arns. // // This member is required. DirectoryArn *string // Reference that identifies the object for which policies will be listed. // // This member is required. ObjectReference *types.ObjectReference // 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 types.ConsistencyLevel // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string }
type ListObjectPoliciesOutput ¶
type ListObjectPoliciesOutput struct { // A list of policy ObjectIdentifiers, that are attached to the object. AttachedPolicyIds []*string // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListOutgoingTypedLinksInput ¶
type ListOutgoingTypedLinksInput struct { // The Amazon Resource Name (ARN) of the directory where you want to list the typed // links. // // This member is required. DirectoryArn *string // A reference that identifies the object whose attributes will be listed. // // This member is required. ObjectReference *types.ObjectReference // The consistency level to execute the request at. ConsistencyLevel types.ConsistencyLevel // Provides range filters for multiple attributes. When providing ranges to typed // link selection, any inexact ranges must be specified at the end. Any attributes // that do not have a range specified are presumed to match the entire range. FilterAttributeRanges []*types.TypedLinkAttributeRange // Filters are interpreted in the order of the attributes defined on the typed link // facet, not the order they are supplied to any API calls. FilterTypedLink *types.TypedLinkSchemaAndFacetName // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListOutgoingTypedLinksOutput ¶
type ListOutgoingTypedLinksOutput struct { // The pagination token. NextToken *string // Returns a typed link specifier as output. TypedLinkSpecifiers []*types.TypedLinkSpecifier // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPolicyAttachmentsInput ¶
type ListPolicyAttachmentsInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory where // objects reside. For more information, see arns. // // This member is required. DirectoryArn *string // The reference that identifies the policy object. // // This member is required. PolicyReference *types.ObjectReference // 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 types.ConsistencyLevel // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The pagination token. NextToken *string }
type ListPolicyAttachmentsOutput ¶
type ListPolicyAttachmentsOutput struct { // The pagination token. NextToken *string // A list of ObjectIdentifiers to which the policy is attached. ObjectIdentifiers []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListPublishedSchemaArnsInput ¶
type ListPublishedSchemaArnsInput struct { // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string // The response for ListPublishedSchemaArns when this parameter is used will list // all minor version ARNs for a major version. SchemaArn *string }
type ListPublishedSchemaArnsOutput ¶
type ListPublishedSchemaArnsOutput struct { // The pagination token. NextToken *string // The ARNs of published schemas. SchemaArns []*string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource. Tagging is only supported for // directories. // // This member is required. ResourceArn *string // 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 *int32 // The pagination token. This is for future use. Currently pagination is not // supported for tagging. NextToken *string }
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 // A list of tag key value pairs that are associated with the response. Tags []*types.Tag // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTypedLinkFacetAttributesInput ¶
type ListTypedLinkFacetAttributesInput struct { // The unique name of the typed link facet. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. // // This member is required. SchemaArn *string // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListTypedLinkFacetAttributesOutput ¶
type ListTypedLinkFacetAttributesOutput struct { // An ordered set of attributes associate with the typed link. Attributes []*types.TypedLinkAttributeDefinition // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ListTypedLinkFacetNamesInput ¶
type ListTypedLinkFacetNamesInput struct { // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. // // This member is required. SchemaArn *string // The maximum number of results to retrieve. MaxResults *int32 // The pagination token. NextToken *string }
type ListTypedLinkFacetNamesOutput ¶
type ListTypedLinkFacetNamesOutput struct { // The names of typed link facets that exist within the schema. FacetNames []*string // The pagination token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type LookupPolicyInput ¶
type LookupPolicyInput struct { // The Amazon Resource Name (ARN) that is associated with the Directory. For more // information, see arns. // // This member is required. DirectoryArn *string // Reference that identifies the object whose policies will be looked up. // // This member is required. ObjectReference *types.ObjectReference // The maximum number of items to be retrieved in a single call. This is an // approximate number. MaxResults *int32 // The token to request the next page of results. NextToken *string }
type LookupPolicyOutput ¶
type LookupPolicyOutput struct { // The pagination token. NextToken *string // Provides list of path to policies. Policies contain PolicyId, ObjectIdentifier, // and PolicyType. For more information, see Policies // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies). PolicyToPathList []*types.PolicyToPath // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
type PublishSchemaInput ¶
type PublishSchemaInput struct { // The Amazon Resource Name (ARN) that is associated with the development schema. // For more information, see arns. // // This member is required. DevelopmentSchemaArn *string // The major version under which the schema will be published. Schemas have both a // major and minor version associated with them. // // This member is required. Version *string // The minor version under which the schema will be published. This parameter is // recommended. Schemas have both a major and minor version associated with them. MinorVersion *string // The new name under which the schema will be published. If this is not provided, // the development schema is considered. Name *string }
type PublishSchemaOutput ¶
type PublishSchemaOutput struct { // The ARN that is associated with the published schema. For more information, see // arns. PublishedSchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type PutSchemaFromJsonInput ¶
type PutSchemaFromJsonInput struct { // The replacement JSON schema. // // This member is required. Document *string // The ARN of the schema to update. // // This member is required. SchemaArn *string }
type PutSchemaFromJsonOutput ¶
type PutSchemaFromJsonOutput struct { // The ARN of the schema to update. Arn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type RemoveFacetFromObjectInput ¶
type RemoveFacetFromObjectInput struct { // The ARN of the directory in which the object resides. // // This member is required. DirectoryArn *string // A reference to the object to remove the facet from. // // This member is required. ObjectReference *types.ObjectReference // The facet to remove. See SchemaFacet for details. // // This member is required. SchemaFacet *types.SchemaFacet }
type RemoveFacetFromObjectOutput ¶
type RemoveFacetFromObjectOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. Tagging is only supported for // directories. // // This member is required. ResourceArn *string // A list of tag key-value pairs. // // This member is required. Tags []*types.Tag }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The Amazon Resource Name (ARN) of the resource. Tagging is only supported for // directories. // // This member is required. ResourceArn *string // Keys of the tag that need to be removed from the resource. // // This member is required. TagKeys []*string }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateFacetInput ¶
type UpdateFacetInput struct { // The name of the facet. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the Facet. For more // information, see arns. // // This member is required. SchemaArn *string // 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 []*types.FacetAttributeUpdate // The object type that is associated with the facet. See // CreateFacetRequest$ObjectType for more details. ObjectType types.ObjectType }
type UpdateFacetOutput ¶
type UpdateFacetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateLinkAttributesInput ¶
type UpdateLinkAttributesInput struct { // The attributes update structure. // // This member is required. AttributeUpdates []*types.LinkAttributeUpdate // The Amazon Resource Name (ARN) that is associated with the Directory where the // updated typed link resides. For more information, see arns or Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). // // This member is required. DirectoryArn *string // Allows a typed link specifier to be accepted as input. // // This member is required. TypedLinkSpecifier *types.TypedLinkSpecifier }
type UpdateLinkAttributesOutput ¶
type UpdateLinkAttributesOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateObjectAttributesInput ¶
type UpdateObjectAttributesInput struct { // The attributes update structure. // // This member is required. AttributeUpdates []*types.ObjectAttributeUpdate // The Amazon Resource Name (ARN) that is associated with the Directory where the // object resides. For more information, see arns. // // This member is required. DirectoryArn *string // The reference that identifies the object. // // This member is required. ObjectReference *types.ObjectReference }
type UpdateObjectAttributesOutput ¶
type UpdateObjectAttributesOutput struct { // The ObjectIdentifier of the updated object. ObjectIdentifier *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateSchemaInput ¶
type UpdateSchemaInput struct { // The name of the schema. // // This member is required. Name *string // The Amazon Resource Name (ARN) of the development schema. For more information, // see arns. // // This member is required. SchemaArn *string }
type UpdateSchemaOutput ¶
type UpdateSchemaOutput struct { // The ARN that is associated with the updated schema. For more information, see // arns. SchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTypedLinkFacetInput ¶
type UpdateTypedLinkFacetInput struct { // Attributes update structure. // // This member is required. AttributeUpdates []*types.TypedLinkFacetAttributeUpdate // The order of identity attributes for the facet, from most significant to least // significant. The ability to filter typed links considers the order that the // attributes are defined on the typed link facet. When providing ranges to a typed // link selection, any inexact ranges must be specified at the end. Any attributes // that do not have a range specified are presumed to match the entire range. // Filters are interpreted in the order of the attributes on the typed link facet, // not the order in which they are supplied to any API calls. For more information // about identity attributes, see Typed Links // (https://docs.aws.amazon.com/clouddirectory/latest/developerguide/directory_objects_links.html#directory_objects_links_typedlink). // // This member is required. IdentityAttributeOrder []*string // The unique name of the typed link facet. // // This member is required. Name *string // The Amazon Resource Name (ARN) that is associated with the schema. For more // information, see arns. // // This member is required. SchemaArn *string }
type UpdateTypedLinkFacetOutput ¶
type UpdateTypedLinkFacetOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpgradeAppliedSchemaInput ¶
type UpgradeAppliedSchemaInput struct { // The ARN for the directory to which the upgraded schema will be applied. // // This member is required. DirectoryArn *string // The revision of the published schema to upgrade the directory to. // // This member is required. PublishedSchemaArn *string // Used for testing whether the major version schemas are backward compatible or // not. If schema compatibility fails, an exception would be thrown else the call // would succeed but no changes will be saved. This parameter is optional. DryRun *bool }
type UpgradeAppliedSchemaOutput ¶
type UpgradeAppliedSchemaOutput struct { // The ARN of the directory that is returned as part of the response. DirectoryArn *string // The ARN of the upgraded schema that is returned as part of the response. UpgradedSchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpgradePublishedSchemaInput ¶
type UpgradePublishedSchemaInput struct { // The ARN of the development schema with the changes used for the upgrade. // // This member is required. DevelopmentSchemaArn *string // Identifies the minor version of the published schema that will be created. This // parameter is NOT optional. // // This member is required. MinorVersion *string // The ARN of the published schema to be upgraded. // // This member is required. PublishedSchemaArn *string // Used for testing whether the Development schema provided is backwards // compatible, or not, with the publish schema provided by the user to be upgraded. // If schema compatibility fails, an exception would be thrown else the call would // succeed. This parameter is optional and defaults to false. DryRun *bool }
type UpgradePublishedSchemaOutput ¶
type UpgradePublishedSchemaOutput struct { // The ARN of the upgraded schema that is returned as part of the response. UpgradedSchemaArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_AddFacetToObject.go api_op_ApplySchema.go api_op_AttachObject.go api_op_AttachPolicy.go api_op_AttachToIndex.go api_op_AttachTypedLink.go api_op_BatchRead.go api_op_BatchWrite.go api_op_CreateDirectory.go api_op_CreateFacet.go api_op_CreateIndex.go api_op_CreateObject.go api_op_CreateSchema.go api_op_CreateTypedLinkFacet.go api_op_DeleteDirectory.go api_op_DeleteFacet.go api_op_DeleteObject.go api_op_DeleteSchema.go api_op_DeleteTypedLinkFacet.go api_op_DetachFromIndex.go api_op_DetachObject.go api_op_DetachPolicy.go api_op_DetachTypedLink.go api_op_DisableDirectory.go api_op_EnableDirectory.go api_op_GetAppliedSchemaVersion.go api_op_GetDirectory.go api_op_GetFacet.go api_op_GetLinkAttributes.go api_op_GetObjectAttributes.go api_op_GetObjectInformation.go api_op_GetSchemaAsJson.go api_op_GetTypedLinkFacetInformation.go api_op_ListAppliedSchemaArns.go api_op_ListAttachedIndices.go api_op_ListDevelopmentSchemaArns.go api_op_ListDirectories.go api_op_ListFacetAttributes.go api_op_ListFacetNames.go api_op_ListIncomingTypedLinks.go api_op_ListIndex.go api_op_ListManagedSchemaArns.go api_op_ListObjectAttributes.go api_op_ListObjectChildren.go api_op_ListObjectParentPaths.go api_op_ListObjectParents.go api_op_ListObjectPolicies.go api_op_ListOutgoingTypedLinks.go api_op_ListPolicyAttachments.go api_op_ListPublishedSchemaArns.go api_op_ListTagsForResource.go api_op_ListTypedLinkFacetAttributes.go api_op_ListTypedLinkFacetNames.go api_op_LookupPolicy.go api_op_PublishSchema.go api_op_PutSchemaFromJson.go api_op_RemoveFacetFromObject.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateFacet.go api_op_UpdateLinkAttributes.go api_op_UpdateObjectAttributes.go api_op_UpdateSchema.go api_op_UpdateTypedLinkFacet.go api_op_UpgradeAppliedSchema.go api_op_UpgradePublishedSchema.go deserializers.go doc.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.28.0
- Published
- Oct 26, 2020
- Platform
- js/wasm
- Imports
- 27 packages
- Last checked
- now –
Tools for package owners.