clouddirectory

package module
v1.24.6 Latest Latest
Warning

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

 Go to latest Published: Nov 18, 2024 License: Apache-2.0 Imports: 44 Imported by: 21

Documentation

Overview

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 Serviceand the Amazon Cloud Directory Developer Guide.

Index

Constants

View Source 
const ServiceAPIVersion = "2017-01-11"
View Source 
const ServiceID = "CloudDirectory"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.14.0 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.17.2 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.17.2 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

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

type AddFacetToObjectOutput 

type AddFacetToObjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

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

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

type AttachPolicyOutput 

type AttachPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

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

type AuthResolverParameters added in v1.17.2 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.17.2 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

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

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

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

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

type Client 

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

Client provides the API client to make operations call for Amazon CloudDirectory.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

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

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

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.

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.

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

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

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

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.

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

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.

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.

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.

func (*Client) Options added in v1.18.0 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

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

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

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

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].
	//
	//   - Index: Can be created with the Index API.
	//
	// [Policies]: https://docs.aws.amazon.com/clouddirectory/latest/developerguide/key_concepts_directory.html#key_concepts_policies
	ObjectType types.ObjectType
	// contains filtered or unexported fields
}

type CreateFacetOutput 

type CreateFacetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

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

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

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

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

type CreateTypedLinkFacetOutput 

type CreateTypedLinkFacetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteDirectoryInput 

type DeleteDirectoryInput struct {

	// The ARN of the directory to delete.
	//
	// This member is required.
	DirectoryArn *string
	// contains filtered or unexported fields
}

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

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

type DeleteFacetOutput 

type DeleteFacetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DeleteObjectOutput 

type DeleteObjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

type DeleteTypedLinkFacetOutput 

type DeleteTypedLinkFacetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

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

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

type DetachPolicyOutput 

type DetachPolicyOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type DetachTypedLinkOutput 

type DetachTypedLinkOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisableDirectoryInput 

type DisableDirectoryInput struct {

	// The ARN of the directory to disable.
	//
	// This member is required.
	DirectoryArn *string
	// contains filtered or unexported fields
}

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

type EnableDirectoryInput 

type EnableDirectoryInput struct {

	// The ARN of the directory to enable.
	//
	// This member is required.
	DirectoryArn *string
	// contains filtered or unexported fields
}

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

type EndpointParameters added in v1.14.0 

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.14.0 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.14.0 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (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 EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.14.0 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.14.0 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetAppliedSchemaVersionInput 

type GetAppliedSchemaVersionInput struct {

	// The ARN of the applied schema.
	//
	// This member is required.
	SchemaArn *string
	// contains filtered or unexported fields
}

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

type GetDirectoryInput 

type GetDirectoryInput struct {

	// The ARN of the directory.
	//
	// This member is required.
	DirectoryArn *string
	// contains filtered or unexported fields
}

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

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

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

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 arnsor [Typed Links].
	//
	// [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
	// contains filtered or unexported fields
}

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

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

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

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

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 GetAppliedSchemaVersionfor details.
	SchemaFacets []types.SchemaFacet

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSchemaAsJsonInput 

type GetSchemaAsJsonInput struct {

	// The ARN of the schema to retrieve.
	//
	// This member is required.
	SchemaArn *string
	// contains filtered or unexported fields
}

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

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

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].
	//
	// [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
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListAppliedSchemaArnsAPIClient added in v0.30.0 

type ListAppliedSchemaArnsAPIClient interface {
	ListAppliedSchemaArns(context.Context, *ListAppliedSchemaArnsInput, ...func(*Options)) (*ListAppliedSchemaArnsOutput, error)
}

ListAppliedSchemaArnsAPIClient is a client that implements the ListAppliedSchemaArns operation.

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

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

type ListAppliedSchemaArnsPaginator added in v0.30.0 

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

ListAppliedSchemaArnsPaginator is a paginator for ListAppliedSchemaArns

func NewListAppliedSchemaArnsPaginator added in v0.30.0 

func NewListAppliedSchemaArnsPaginator(client ListAppliedSchemaArnsAPIClient, params *ListAppliedSchemaArnsInput, optFns ...func(*ListAppliedSchemaArnsPaginatorOptions)) *ListAppliedSchemaArnsPaginator

NewListAppliedSchemaArnsPaginator returns a new ListAppliedSchemaArnsPaginator

func (*ListAppliedSchemaArnsPaginator) HasMorePages added in v0.30.0 

func (p *ListAppliedSchemaArnsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAppliedSchemaArnsPaginator) NextPage added in v0.30.0 

func (p *ListAppliedSchemaArnsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAppliedSchemaArnsOutput, error)

NextPage retrieves the next ListAppliedSchemaArns page.

type ListAppliedSchemaArnsPaginatorOptions added in v0.30.0 

type ListAppliedSchemaArnsPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAppliedSchemaArnsPaginatorOptions is the paginator options for ListAppliedSchemaArns

type ListAttachedIndicesAPIClient added in v0.30.0 

type ListAttachedIndicesAPIClient interface {
	ListAttachedIndices(context.Context, *ListAttachedIndicesInput, ...func(*Options)) (*ListAttachedIndicesOutput, error)
}

ListAttachedIndicesAPIClient is a client that implements the ListAttachedIndices operation.

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

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

type ListAttachedIndicesPaginator added in v0.30.0 

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

ListAttachedIndicesPaginator is a paginator for ListAttachedIndices

func NewListAttachedIndicesPaginator added in v0.30.0 

func NewListAttachedIndicesPaginator(client ListAttachedIndicesAPIClient, params *ListAttachedIndicesInput, optFns ...func(*ListAttachedIndicesPaginatorOptions)) *ListAttachedIndicesPaginator

NewListAttachedIndicesPaginator returns a new ListAttachedIndicesPaginator

func (*ListAttachedIndicesPaginator) HasMorePages added in v0.30.0 

func (p *ListAttachedIndicesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAttachedIndicesPaginator) NextPage added in v0.30.0 

func (p *ListAttachedIndicesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAttachedIndicesOutput, error)

NextPage retrieves the next ListAttachedIndices page.

type ListAttachedIndicesPaginatorOptions added in v0.30.0 

type ListAttachedIndicesPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAttachedIndicesPaginatorOptions is the paginator options for ListAttachedIndices

type ListDevelopmentSchemaArnsAPIClient added in v0.30.0 

type ListDevelopmentSchemaArnsAPIClient interface {
	ListDevelopmentSchemaArns(context.Context, *ListDevelopmentSchemaArnsInput, ...func(*Options)) (*ListDevelopmentSchemaArnsOutput, error)
}

ListDevelopmentSchemaArnsAPIClient is a client that implements the ListDevelopmentSchemaArns operation.

type ListDevelopmentSchemaArnsInput 

type ListDevelopmentSchemaArnsInput struct {

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

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

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

type ListDevelopmentSchemaArnsPaginator added in v0.30.0 

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

ListDevelopmentSchemaArnsPaginator is a paginator for ListDevelopmentSchemaArns

func NewListDevelopmentSchemaArnsPaginator added in v0.30.0 

func NewListDevelopmentSchemaArnsPaginator(client ListDevelopmentSchemaArnsAPIClient, params *ListDevelopmentSchemaArnsInput, optFns ...func(*ListDevelopmentSchemaArnsPaginatorOptions)) *ListDevelopmentSchemaArnsPaginator

NewListDevelopmentSchemaArnsPaginator returns a new ListDevelopmentSchemaArnsPaginator

func (*ListDevelopmentSchemaArnsPaginator) HasMorePages added in v0.30.0 

func (p *ListDevelopmentSchemaArnsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDevelopmentSchemaArnsPaginator) NextPage added in v0.30.0 

func (p *ListDevelopmentSchemaArnsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDevelopmentSchemaArnsOutput, error)

NextPage retrieves the next ListDevelopmentSchemaArns page.

type ListDevelopmentSchemaArnsPaginatorOptions added in v0.30.0 

type ListDevelopmentSchemaArnsPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDevelopmentSchemaArnsPaginatorOptions is the paginator options for ListDevelopmentSchemaArns

type ListDirectoriesAPIClient added in v0.30.0 

type ListDirectoriesAPIClient interface {
	ListDirectories(context.Context, *ListDirectoriesInput, ...func(*Options)) (*ListDirectoriesOutput, error)
}

ListDirectoriesAPIClient is a client that implements the ListDirectories operation.

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

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

type ListDirectoriesPaginator added in v0.30.0 

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

ListDirectoriesPaginator is a paginator for ListDirectories

func NewListDirectoriesPaginator added in v0.30.0 

func NewListDirectoriesPaginator(client ListDirectoriesAPIClient, params *ListDirectoriesInput, optFns ...func(*ListDirectoriesPaginatorOptions)) *ListDirectoriesPaginator

NewListDirectoriesPaginator returns a new ListDirectoriesPaginator

func (*ListDirectoriesPaginator) HasMorePages added in v0.30.0 

func (p *ListDirectoriesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListDirectoriesPaginator) NextPage added in v0.30.0 

func (p *ListDirectoriesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDirectoriesOutput, error)

NextPage retrieves the next ListDirectories page.

type ListDirectoriesPaginatorOptions added in v0.30.0 

type ListDirectoriesPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListDirectoriesPaginatorOptions is the paginator options for ListDirectories

type ListFacetAttributesAPIClient added in v0.30.0 

type ListFacetAttributesAPIClient interface {
	ListFacetAttributes(context.Context, *ListFacetAttributesInput, ...func(*Options)) (*ListFacetAttributesOutput, error)
}

ListFacetAttributesAPIClient is a client that implements the ListFacetAttributes operation.

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

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

type ListFacetAttributesPaginator added in v0.30.0 

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

ListFacetAttributesPaginator is a paginator for ListFacetAttributes

func NewListFacetAttributesPaginator added in v0.30.0 

func NewListFacetAttributesPaginator(client ListFacetAttributesAPIClient, params *ListFacetAttributesInput, optFns ...func(*ListFacetAttributesPaginatorOptions)) *ListFacetAttributesPaginator

NewListFacetAttributesPaginator returns a new ListFacetAttributesPaginator

func (*ListFacetAttributesPaginator) HasMorePages added in v0.30.0 

func (p *ListFacetAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFacetAttributesPaginator) NextPage added in v0.30.0 

func (p *ListFacetAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFacetAttributesOutput, error)

NextPage retrieves the next ListFacetAttributes page.

type ListFacetAttributesPaginatorOptions added in v0.30.0 

type ListFacetAttributesPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFacetAttributesPaginatorOptions is the paginator options for ListFacetAttributes

type ListFacetNamesAPIClient added in v0.30.0 

type ListFacetNamesAPIClient interface {
	ListFacetNames(context.Context, *ListFacetNamesInput, ...func(*Options)) (*ListFacetNamesOutput, error)
}

ListFacetNamesAPIClient is a client that implements the ListFacetNames operation.

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

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

type ListFacetNamesPaginator added in v0.30.0 

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

ListFacetNamesPaginator is a paginator for ListFacetNames

func NewListFacetNamesPaginator added in v0.30.0 

func NewListFacetNamesPaginator(client ListFacetNamesAPIClient, params *ListFacetNamesInput, optFns ...func(*ListFacetNamesPaginatorOptions)) *ListFacetNamesPaginator

NewListFacetNamesPaginator returns a new ListFacetNamesPaginator

func (*ListFacetNamesPaginator) HasMorePages added in v0.30.0 

func (p *ListFacetNamesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListFacetNamesPaginator) NextPage added in v0.30.0 

func (p *ListFacetNamesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFacetNamesOutput, error)

NextPage retrieves the next ListFacetNames page.

type ListFacetNamesPaginatorOptions added in v0.30.0 

type ListFacetNamesPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListFacetNamesPaginatorOptions is the paginator options for ListFacetNames

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

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

type ListIndexAPIClient added in v0.30.0 

type ListIndexAPIClient interface {
	ListIndex(context.Context, *ListIndexInput, ...func(*Options)) (*ListIndexOutput, error)
}

ListIndexAPIClient is a client that implements the ListIndex operation.

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].
	//
	// [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
	// contains filtered or unexported fields
}

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

type ListIndexPaginator added in v0.30.0 

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

ListIndexPaginator is a paginator for ListIndex

func NewListIndexPaginator added in v0.30.0 

func NewListIndexPaginator(client ListIndexAPIClient, params *ListIndexInput, optFns ...func(*ListIndexPaginatorOptions)) *ListIndexPaginator

NewListIndexPaginator returns a new ListIndexPaginator

func (*ListIndexPaginator) HasMorePages added in v0.30.0 

func (p *ListIndexPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListIndexPaginator) NextPage added in v0.30.0 

func (p *ListIndexPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListIndexOutput, error)

NextPage retrieves the next ListIndex page.

type ListIndexPaginatorOptions added in v0.30.0 

type ListIndexPaginatorOptions struct {
	// 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].
	//
	// [Amazon Cloud Directory Limits]: http://docs.aws.amazon.com/clouddirectory/latest/developerguide/limits.html
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListIndexPaginatorOptions is the paginator options for ListIndex

type ListManagedSchemaArnsAPIClient added in v0.30.0 

type ListManagedSchemaArnsAPIClient interface {
	ListManagedSchemaArns(context.Context, *ListManagedSchemaArnsInput, ...func(*Options)) (*ListManagedSchemaArnsOutput, error)
}

ListManagedSchemaArnsAPIClient is a client that implements the ListManagedSchemaArns operation.

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

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

type ListManagedSchemaArnsPaginator added in v0.30.0 

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

ListManagedSchemaArnsPaginator is a paginator for ListManagedSchemaArns

func NewListManagedSchemaArnsPaginator added in v0.30.0 

func NewListManagedSchemaArnsPaginator(client ListManagedSchemaArnsAPIClient, params *ListManagedSchemaArnsInput, optFns ...func(*ListManagedSchemaArnsPaginatorOptions)) *ListManagedSchemaArnsPaginator

NewListManagedSchemaArnsPaginator returns a new ListManagedSchemaArnsPaginator

func (*ListManagedSchemaArnsPaginator) HasMorePages added in v0.30.0 

func (p *ListManagedSchemaArnsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListManagedSchemaArnsPaginator) NextPage added in v0.30.0 

func (p *ListManagedSchemaArnsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListManagedSchemaArnsOutput, error)

NextPage retrieves the next ListManagedSchemaArns page.

type ListManagedSchemaArnsPaginatorOptions added in v0.30.0 

type ListManagedSchemaArnsPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListManagedSchemaArnsPaginatorOptions is the paginator options for ListManagedSchemaArns

type ListObjectAttributesAPIClient added in v0.30.0 

type ListObjectAttributesAPIClient interface {
	ListObjectAttributes(context.Context, *ListObjectAttributesInput, ...func(*Options)) (*ListObjectAttributesOutput, error)
}

ListObjectAttributesAPIClient is a client that implements the ListObjectAttributes operation.

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

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

type ListObjectAttributesPaginator added in v0.30.0 

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

ListObjectAttributesPaginator is a paginator for ListObjectAttributes

func NewListObjectAttributesPaginator added in v0.30.0 

func NewListObjectAttributesPaginator(client ListObjectAttributesAPIClient, params *ListObjectAttributesInput, optFns ...func(*ListObjectAttributesPaginatorOptions)) *ListObjectAttributesPaginator

NewListObjectAttributesPaginator returns a new ListObjectAttributesPaginator

func (*ListObjectAttributesPaginator) HasMorePages added in v0.30.0 

func (p *ListObjectAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListObjectAttributesPaginator) NextPage added in v0.30.0 

func (p *ListObjectAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectAttributesOutput, error)

NextPage retrieves the next ListObjectAttributes page.

type ListObjectAttributesPaginatorOptions added in v0.30.0 

type ListObjectAttributesPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListObjectAttributesPaginatorOptions is the paginator options for ListObjectAttributes

type ListObjectChildrenAPIClient added in v0.30.0 

type ListObjectChildrenAPIClient interface {
	ListObjectChildren(context.Context, *ListObjectChildrenInput, ...func(*Options)) (*ListObjectChildrenOutput, error)
}

ListObjectChildrenAPIClient is a client that implements the ListObjectChildren operation.

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

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

type ListObjectChildrenPaginator added in v0.30.0 

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

ListObjectChildrenPaginator is a paginator for ListObjectChildren

func NewListObjectChildrenPaginator added in v0.30.0 

func NewListObjectChildrenPaginator(client ListObjectChildrenAPIClient, params *ListObjectChildrenInput, optFns ...func(*ListObjectChildrenPaginatorOptions)) *ListObjectChildrenPaginator

NewListObjectChildrenPaginator returns a new ListObjectChildrenPaginator

func (*ListObjectChildrenPaginator) HasMorePages added in v0.30.0 

func (p *ListObjectChildrenPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListObjectChildrenPaginator) NextPage added in v0.30.0 

func (p *ListObjectChildrenPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectChildrenOutput, error)

NextPage retrieves the next ListObjectChildren page.

type ListObjectChildrenPaginatorOptions added in v0.30.0 

type ListObjectChildrenPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListObjectChildrenPaginatorOptions is the paginator options for ListObjectChildren

type ListObjectParentPathsAPIClient added in v0.30.0 

type ListObjectParentPathsAPIClient interface {
	ListObjectParentPaths(context.Context, *ListObjectParentPathsInput, ...func(*Options)) (*ListObjectParentPathsOutput, error)
}

ListObjectParentPathsAPIClient is a client that implements the ListObjectParentPaths operation.

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

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

type ListObjectParentPathsPaginator added in v0.30.0 

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

ListObjectParentPathsPaginator is a paginator for ListObjectParentPaths

func NewListObjectParentPathsPaginator added in v0.30.0 

func NewListObjectParentPathsPaginator(client ListObjectParentPathsAPIClient, params *ListObjectParentPathsInput, optFns ...func(*ListObjectParentPathsPaginatorOptions)) *ListObjectParentPathsPaginator

NewListObjectParentPathsPaginator returns a new ListObjectParentPathsPaginator

func (*ListObjectParentPathsPaginator) HasMorePages added in v0.30.0 

func (p *ListObjectParentPathsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListObjectParentPathsPaginator) NextPage added in v0.30.0 

func (p *ListObjectParentPathsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectParentPathsOutput, error)

NextPage retrieves the next ListObjectParentPaths page.

type ListObjectParentPathsPaginatorOptions added in v0.30.0 

type ListObjectParentPathsPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListObjectParentPathsPaginatorOptions is the paginator options for ListObjectParentPaths

type ListObjectParentsAPIClient added in v0.30.0 

type ListObjectParentsAPIClient interface {
	ListObjectParents(context.Context, *ListObjectParentsInput, ...func(*Options)) (*ListObjectParentsOutput, error)
}

ListObjectParentsAPIClient is a client that implements the ListObjectParents operation.

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

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

type ListObjectParentsPaginator added in v0.30.0 

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

ListObjectParentsPaginator is a paginator for ListObjectParents

func NewListObjectParentsPaginator added in v0.30.0 

func NewListObjectParentsPaginator(client ListObjectParentsAPIClient, params *ListObjectParentsInput, optFns ...func(*ListObjectParentsPaginatorOptions)) *ListObjectParentsPaginator

NewListObjectParentsPaginator returns a new ListObjectParentsPaginator

func (*ListObjectParentsPaginator) HasMorePages added in v0.30.0 

func (p *ListObjectParentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListObjectParentsPaginator) NextPage added in v0.30.0 

func (p *ListObjectParentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectParentsOutput, error)

NextPage retrieves the next ListObjectParents page.

type ListObjectParentsPaginatorOptions added in v0.30.0 

type ListObjectParentsPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListObjectParentsPaginatorOptions is the paginator options for ListObjectParents

type ListObjectPoliciesAPIClient added in v0.30.0 

type ListObjectPoliciesAPIClient interface {
	ListObjectPolicies(context.Context, *ListObjectPoliciesInput, ...func(*Options)) (*ListObjectPoliciesOutput, error)
}

ListObjectPoliciesAPIClient is a client that implements the ListObjectPolicies operation.

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

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

type ListObjectPoliciesPaginator added in v0.30.0 

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

ListObjectPoliciesPaginator is a paginator for ListObjectPolicies

func NewListObjectPoliciesPaginator added in v0.30.0 

func NewListObjectPoliciesPaginator(client ListObjectPoliciesAPIClient, params *ListObjectPoliciesInput, optFns ...func(*ListObjectPoliciesPaginatorOptions)) *ListObjectPoliciesPaginator

NewListObjectPoliciesPaginator returns a new ListObjectPoliciesPaginator

func (*ListObjectPoliciesPaginator) HasMorePages added in v0.30.0 

func (p *ListObjectPoliciesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListObjectPoliciesPaginator) NextPage added in v0.30.0 

func (p *ListObjectPoliciesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListObjectPoliciesOutput, error)

NextPage retrieves the next ListObjectPolicies page.

type ListObjectPoliciesPaginatorOptions added in v0.30.0 

type ListObjectPoliciesPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListObjectPoliciesPaginatorOptions is the paginator options for ListObjectPolicies

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

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

type ListPolicyAttachmentsAPIClient added in v0.30.0 

type ListPolicyAttachmentsAPIClient interface {
	ListPolicyAttachments(context.Context, *ListPolicyAttachmentsInput, ...func(*Options)) (*ListPolicyAttachmentsOutput, error)
}

ListPolicyAttachmentsAPIClient is a client that implements the ListPolicyAttachments operation.

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

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

type ListPolicyAttachmentsPaginator added in v0.30.0 

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

ListPolicyAttachmentsPaginator is a paginator for ListPolicyAttachments

func NewListPolicyAttachmentsPaginator added in v0.30.0 

func NewListPolicyAttachmentsPaginator(client ListPolicyAttachmentsAPIClient, params *ListPolicyAttachmentsInput, optFns ...func(*ListPolicyAttachmentsPaginatorOptions)) *ListPolicyAttachmentsPaginator

NewListPolicyAttachmentsPaginator returns a new ListPolicyAttachmentsPaginator

func (*ListPolicyAttachmentsPaginator) HasMorePages added in v0.30.0 

func (p *ListPolicyAttachmentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPolicyAttachmentsPaginator) NextPage added in v0.30.0 

func (p *ListPolicyAttachmentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPolicyAttachmentsOutput, error)

NextPage retrieves the next ListPolicyAttachments page.

type ListPolicyAttachmentsPaginatorOptions added in v0.30.0 

type ListPolicyAttachmentsPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPolicyAttachmentsPaginatorOptions is the paginator options for ListPolicyAttachments

type ListPublishedSchemaArnsAPIClient added in v0.30.0 

type ListPublishedSchemaArnsAPIClient interface {
	ListPublishedSchemaArns(context.Context, *ListPublishedSchemaArnsInput, ...func(*Options)) (*ListPublishedSchemaArnsOutput, error)
}

ListPublishedSchemaArnsAPIClient is a client that implements the ListPublishedSchemaArns operation.

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

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

type ListPublishedSchemaArnsPaginator added in v0.30.0 

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

ListPublishedSchemaArnsPaginator is a paginator for ListPublishedSchemaArns

func NewListPublishedSchemaArnsPaginator added in v0.30.0 

func NewListPublishedSchemaArnsPaginator(client ListPublishedSchemaArnsAPIClient, params *ListPublishedSchemaArnsInput, optFns ...func(*ListPublishedSchemaArnsPaginatorOptions)) *ListPublishedSchemaArnsPaginator

NewListPublishedSchemaArnsPaginator returns a new ListPublishedSchemaArnsPaginator

func (*ListPublishedSchemaArnsPaginator) HasMorePages added in v0.30.0 

func (p *ListPublishedSchemaArnsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListPublishedSchemaArnsPaginator) NextPage added in v0.30.0 

func (p *ListPublishedSchemaArnsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListPublishedSchemaArnsOutput, error)

NextPage retrieves the next ListPublishedSchemaArns page.

type ListPublishedSchemaArnsPaginatorOptions added in v0.30.0 

type ListPublishedSchemaArnsPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListPublishedSchemaArnsPaginatorOptions is the paginator options for ListPublishedSchemaArns

type ListTagsForResourceAPIClient added in v0.30.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

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

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

type ListTagsForResourcePaginator added in v0.30.0 

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v0.30.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v0.30.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v0.30.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v0.30.0 

type ListTagsForResourcePaginatorOptions struct {
	// The MaxResults parameter sets the maximum number of results returned in a
	// single page. This is for future use and is not supported currently.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type ListTypedLinkFacetAttributesAPIClient added in v0.30.0 

type ListTypedLinkFacetAttributesAPIClient interface {
	ListTypedLinkFacetAttributes(context.Context, *ListTypedLinkFacetAttributesInput, ...func(*Options)) (*ListTypedLinkFacetAttributesOutput, error)
}

ListTypedLinkFacetAttributesAPIClient is a client that implements the ListTypedLinkFacetAttributes operation.

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

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

type ListTypedLinkFacetAttributesPaginator added in v0.30.0 

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

ListTypedLinkFacetAttributesPaginator is a paginator for ListTypedLinkFacetAttributes

func NewListTypedLinkFacetAttributesPaginator added in v0.30.0 

func NewListTypedLinkFacetAttributesPaginator(client ListTypedLinkFacetAttributesAPIClient, params *ListTypedLinkFacetAttributesInput, optFns ...func(*ListTypedLinkFacetAttributesPaginatorOptions)) *ListTypedLinkFacetAttributesPaginator

NewListTypedLinkFacetAttributesPaginator returns a new ListTypedLinkFacetAttributesPaginator

func (*ListTypedLinkFacetAttributesPaginator) HasMorePages added in v0.30.0 

func (p *ListTypedLinkFacetAttributesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTypedLinkFacetAttributesPaginator) NextPage added in v0.30.0 

func (p *ListTypedLinkFacetAttributesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypedLinkFacetAttributesOutput, error)

NextPage retrieves the next ListTypedLinkFacetAttributes page.

type ListTypedLinkFacetAttributesPaginatorOptions added in v0.30.0 

type ListTypedLinkFacetAttributesPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTypedLinkFacetAttributesPaginatorOptions is the paginator options for ListTypedLinkFacetAttributes

type ListTypedLinkFacetNamesAPIClient added in v0.30.0 

type ListTypedLinkFacetNamesAPIClient interface {
	ListTypedLinkFacetNames(context.Context, *ListTypedLinkFacetNamesInput, ...func(*Options)) (*ListTypedLinkFacetNamesOutput, error)
}

ListTypedLinkFacetNamesAPIClient is a client that implements the ListTypedLinkFacetNames operation.

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

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

type ListTypedLinkFacetNamesPaginator added in v0.30.0 

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

ListTypedLinkFacetNamesPaginator is a paginator for ListTypedLinkFacetNames

func NewListTypedLinkFacetNamesPaginator added in v0.30.0 

func NewListTypedLinkFacetNamesPaginator(client ListTypedLinkFacetNamesAPIClient, params *ListTypedLinkFacetNamesInput, optFns ...func(*ListTypedLinkFacetNamesPaginatorOptions)) *ListTypedLinkFacetNamesPaginator

NewListTypedLinkFacetNamesPaginator returns a new ListTypedLinkFacetNamesPaginator

func (*ListTypedLinkFacetNamesPaginator) HasMorePages added in v0.30.0 

func (p *ListTypedLinkFacetNamesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTypedLinkFacetNamesPaginator) NextPage added in v0.30.0 

func (p *ListTypedLinkFacetNamesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTypedLinkFacetNamesOutput, error)

NextPage retrieves the next ListTypedLinkFacetNames page.

type ListTypedLinkFacetNamesPaginatorOptions added in v0.30.0 

type ListTypedLinkFacetNamesPaginatorOptions struct {
	// The maximum number of results to retrieve.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTypedLinkFacetNamesPaginatorOptions is the paginator options for ListTypedLinkFacetNames

type LookupPolicyAPIClient added in v0.30.0 

type LookupPolicyAPIClient interface {
	LookupPolicy(context.Context, *LookupPolicyInput, ...func(*Options)) (*LookupPolicyOutput, error)
}

LookupPolicyAPIClient is a client that implements the LookupPolicy operation.

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

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].
	//
	// [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
	// contains filtered or unexported fields
}

type LookupPolicyPaginator added in v0.30.0 

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

LookupPolicyPaginator is a paginator for LookupPolicy

func NewLookupPolicyPaginator added in v0.30.0 

func NewLookupPolicyPaginator(client LookupPolicyAPIClient, params *LookupPolicyInput, optFns ...func(*LookupPolicyPaginatorOptions)) *LookupPolicyPaginator

NewLookupPolicyPaginator returns a new LookupPolicyPaginator

func (*LookupPolicyPaginator) HasMorePages added in v0.30.0 

func (p *LookupPolicyPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*LookupPolicyPaginator) NextPage added in v0.30.0 

func (p *LookupPolicyPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*LookupPolicyOutput, error)

NextPage retrieves the next LookupPolicy page.

type LookupPolicyPaginatorOptions added in v0.30.0 

type LookupPolicyPaginatorOptions struct {
	// The maximum number of items to be retrieved in a single call. This is an
	// approximate number.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

LookupPolicyPaginatorOptions is the paginator options for LookupPolicy

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 optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts.
	//
	// If specified in an operation call's functional options with a value that is
	// different than the constructed client's Options, the Client's Retryer will be
	// wrapped to use the operation's specific RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified.
	//
	// When creating a new API Clients this member will only be used if the Retryer
	// Options member is nil. This value will be ignored if Retryer is not nil.
	//
	// Currently does not support per operation call overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.17.2 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

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

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

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

type PutSchemaFromJsonOutput 

type PutSchemaFromJsonOutput struct {

	// The ARN of the schema to update.
	Arn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type RemoveFacetFromObjectOutput 

type RemoveFacetFromObjectOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

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

type TagResourceOutput 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UntagResourceOutput 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UpdateFacetOutput 

type UpdateFacetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 arnsor [Typed Links].
	//
	// [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
	// contains filtered or unexported fields
}

type UpdateLinkAttributesOutput 

type UpdateLinkAttributesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

type UpdateObjectAttributesOutput 

type UpdateObjectAttributesOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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].
	//
	// [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
	// contains filtered or unexported fields
}

type UpdateTypedLinkFacetOutput 

type UpdateTypedLinkFacetOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

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

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

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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