Interface CloudDirectoryClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
Amazon Cloud Directory is a component of the AWS Directory Service that simplifies the development and management of cloud-scale web, mobile, and IoT applications. This guide describes the Cloud Directory operations that you can call programmatically and includes detailed information on data types and errors. For information about Cloud Directory features, see AWS Directory Service and the Amazon Cloud Directory Developer Guide.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptiondefault AddFacetToObjectResponse
addFacetToObject
(Consumer<AddFacetToObjectRequest.Builder> addFacetToObjectRequest) Adds a new Facet to an object.default AddFacetToObjectResponse
addFacetToObject
(AddFacetToObjectRequest addFacetToObjectRequest) Adds a new Facet to an object.default ApplySchemaResponse
applySchema
(Consumer<ApplySchemaRequest.Builder> applySchemaRequest) Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.default ApplySchemaResponse
applySchema
(ApplySchemaRequest applySchemaRequest) Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.default AttachObjectResponse
attachObject
(Consumer<AttachObjectRequest.Builder> attachObjectRequest) Attaches an existing object to another object.default AttachObjectResponse
attachObject
(AttachObjectRequest attachObjectRequest) Attaches an existing object to another object.default AttachPolicyResponse
attachPolicy
(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest) Attaches a policy object to a regular object.default AttachPolicyResponse
attachPolicy
(AttachPolicyRequest attachPolicyRequest) Attaches a policy object to a regular object.default AttachToIndexResponse
attachToIndex
(Consumer<AttachToIndexRequest.Builder> attachToIndexRequest) Attaches the specified object to the specified index.default AttachToIndexResponse
attachToIndex
(AttachToIndexRequest attachToIndexRequest) Attaches the specified object to the specified index.default AttachTypedLinkResponse
attachTypedLink
(Consumer<AttachTypedLinkRequest.Builder> attachTypedLinkRequest) Attaches a typed link to a specified source and target object.default AttachTypedLinkResponse
attachTypedLink
(AttachTypedLinkRequest attachTypedLinkRequest) Attaches a typed link to a specified source and target object.default BatchReadResponse
batchRead
(Consumer<BatchReadRequest.Builder> batchReadRequest) Performs all the read operations in a batch.default BatchReadResponse
batchRead
(BatchReadRequest batchReadRequest) Performs all the read operations in a batch.default BatchWriteResponse
batchWrite
(Consumer<BatchWriteRequest.Builder> batchWriteRequest) Performs all the write operations in a batch.default BatchWriteResponse
batchWrite
(BatchWriteRequest batchWriteRequest) Performs all the write operations in a batch.static CloudDirectoryClientBuilder
builder()
Create a builder that can be used to configure and create aCloudDirectoryClient
.static CloudDirectoryClient
create()
Create aCloudDirectoryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateDirectoryResponse
createDirectory
(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) Creates a Directory by copying the published schema into the directory.default CreateDirectoryResponse
createDirectory
(CreateDirectoryRequest createDirectoryRequest) Creates a Directory by copying the published schema into the directory.default CreateFacetResponse
createFacet
(Consumer<CreateFacetRequest.Builder> createFacetRequest) Creates a new Facet in a schema.default CreateFacetResponse
createFacet
(CreateFacetRequest createFacetRequest) Creates a new Facet in a schema.default CreateIndexResponse
createIndex
(Consumer<CreateIndexRequest.Builder> createIndexRequest) Creates an index object.default CreateIndexResponse
createIndex
(CreateIndexRequest createIndexRequest) Creates an index object.default CreateObjectResponse
createObject
(Consumer<CreateObjectRequest.Builder> createObjectRequest) Creates an object in a Directory.default CreateObjectResponse
createObject
(CreateObjectRequest createObjectRequest) Creates an object in a Directory.default CreateSchemaResponse
createSchema
(Consumer<CreateSchemaRequest.Builder> createSchemaRequest) Creates a new schema in a development state.default CreateSchemaResponse
createSchema
(CreateSchemaRequest createSchemaRequest) Creates a new schema in a development state.default CreateTypedLinkFacetResponse
createTypedLinkFacet
(Consumer<CreateTypedLinkFacetRequest.Builder> createTypedLinkFacetRequest) Creates a TypedLinkFacet.default CreateTypedLinkFacetResponse
createTypedLinkFacet
(CreateTypedLinkFacetRequest createTypedLinkFacetRequest) Creates a TypedLinkFacet.default DeleteDirectoryResponse
deleteDirectory
(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) Deletes a directory.default DeleteDirectoryResponse
deleteDirectory
(DeleteDirectoryRequest deleteDirectoryRequest) Deletes a directory.default DeleteFacetResponse
deleteFacet
(Consumer<DeleteFacetRequest.Builder> deleteFacetRequest) Deletes a given Facet.default DeleteFacetResponse
deleteFacet
(DeleteFacetRequest deleteFacetRequest) Deletes a given Facet.default DeleteObjectResponse
deleteObject
(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest) Deletes an object and its associated attributes.default DeleteObjectResponse
deleteObject
(DeleteObjectRequest deleteObjectRequest) Deletes an object and its associated attributes.default DeleteSchemaResponse
deleteSchema
(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest) Deletes a given schema.default DeleteSchemaResponse
deleteSchema
(DeleteSchemaRequest deleteSchemaRequest) Deletes a given schema.default DeleteTypedLinkFacetResponse
deleteTypedLinkFacet
(Consumer<DeleteTypedLinkFacetRequest.Builder> deleteTypedLinkFacetRequest) Deletes a TypedLinkFacet.default DeleteTypedLinkFacetResponse
deleteTypedLinkFacet
(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest) Deletes a TypedLinkFacet.default DetachFromIndexResponse
detachFromIndex
(Consumer<DetachFromIndexRequest.Builder> detachFromIndexRequest) Detaches the specified object from the specified index.default DetachFromIndexResponse
detachFromIndex
(DetachFromIndexRequest detachFromIndexRequest) Detaches the specified object from the specified index.default DetachObjectResponse
detachObject
(Consumer<DetachObjectRequest.Builder> detachObjectRequest) Detaches a given object from the parent object.default DetachObjectResponse
detachObject
(DetachObjectRequest detachObjectRequest) Detaches a given object from the parent object.default DetachPolicyResponse
detachPolicy
(Consumer<DetachPolicyRequest.Builder> detachPolicyRequest) Detaches a policy from an object.default DetachPolicyResponse
detachPolicy
(DetachPolicyRequest detachPolicyRequest) Detaches a policy from an object.default DetachTypedLinkResponse
detachTypedLink
(Consumer<DetachTypedLinkRequest.Builder> detachTypedLinkRequest) Detaches a typed link from a specified source and target object.default DetachTypedLinkResponse
detachTypedLink
(DetachTypedLinkRequest detachTypedLinkRequest) Detaches a typed link from a specified source and target object.default DisableDirectoryResponse
disableDirectory
(Consumer<DisableDirectoryRequest.Builder> disableDirectoryRequest) Disables the specified directory.default DisableDirectoryResponse
disableDirectory
(DisableDirectoryRequest disableDirectoryRequest) Disables the specified directory.default EnableDirectoryResponse
enableDirectory
(Consumer<EnableDirectoryRequest.Builder> enableDirectoryRequest) Enables the specified directory.default EnableDirectoryResponse
enableDirectory
(EnableDirectoryRequest enableDirectoryRequest) Enables the specified directory.default GetAppliedSchemaVersionResponse
getAppliedSchemaVersion
(Consumer<GetAppliedSchemaVersionRequest.Builder> getAppliedSchemaVersionRequest) Returns current applied schema version ARN, including the minor version in use.default GetAppliedSchemaVersionResponse
getAppliedSchemaVersion
(GetAppliedSchemaVersionRequest getAppliedSchemaVersionRequest) Returns current applied schema version ARN, including the minor version in use.default GetDirectoryResponse
getDirectory
(Consumer<GetDirectoryRequest.Builder> getDirectoryRequest) Retrieves metadata about a directory.default GetDirectoryResponse
getDirectory
(GetDirectoryRequest getDirectoryRequest) Retrieves metadata about a directory.default GetFacetResponse
getFacet
(Consumer<GetFacetRequest.Builder> getFacetRequest) default GetFacetResponse
getFacet
(GetFacetRequest getFacetRequest) default GetLinkAttributesResponse
getLinkAttributes
(Consumer<GetLinkAttributesRequest.Builder> getLinkAttributesRequest) Retrieves attributes that are associated with a typed link.default GetLinkAttributesResponse
getLinkAttributes
(GetLinkAttributesRequest getLinkAttributesRequest) Retrieves attributes that are associated with a typed link.default GetObjectAttributesResponse
getObjectAttributes
(Consumer<GetObjectAttributesRequest.Builder> getObjectAttributesRequest) Retrieves attributes within a facet that are associated with an object.default GetObjectAttributesResponse
getObjectAttributes
(GetObjectAttributesRequest getObjectAttributesRequest) Retrieves attributes within a facet that are associated with an object.default GetObjectInformationResponse
getObjectInformation
(Consumer<GetObjectInformationRequest.Builder> getObjectInformationRequest) Retrieves metadata about an object.default GetObjectInformationResponse
getObjectInformation
(GetObjectInformationRequest getObjectInformationRequest) Retrieves metadata about an object.default GetSchemaAsJsonResponse
getSchemaAsJson
(Consumer<GetSchemaAsJsonRequest.Builder> getSchemaAsJsonRequest) Retrieves a JSON representation of the schema.default GetSchemaAsJsonResponse
getSchemaAsJson
(GetSchemaAsJsonRequest getSchemaAsJsonRequest) Retrieves a JSON representation of the schema.getTypedLinkFacetInformation
(Consumer<GetTypedLinkFacetInformationRequest.Builder> getTypedLinkFacetInformationRequest) Returns the identity attribute order for a specific TypedLinkFacet.getTypedLinkFacetInformation
(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest) Returns the identity attribute order for a specific TypedLinkFacet.default ListAppliedSchemaArnsResponse
listAppliedSchemaArns
(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest) Lists schema major versions applied to a directory.default ListAppliedSchemaArnsResponse
listAppliedSchemaArns
(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest) Lists schema major versions applied to a directory.default ListAppliedSchemaArnsIterable
listAppliedSchemaArnsPaginator
(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest) This is a variant oflistAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation.default ListAppliedSchemaArnsIterable
listAppliedSchemaArnsPaginator
(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest) This is a variant oflistAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation.default ListAttachedIndicesResponse
listAttachedIndices
(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest) Lists indices attached to the specified object.default ListAttachedIndicesResponse
listAttachedIndices
(ListAttachedIndicesRequest listAttachedIndicesRequest) Lists indices attached to the specified object.default ListAttachedIndicesIterable
listAttachedIndicesPaginator
(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest) This is a variant oflistAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation.default ListAttachedIndicesIterable
listAttachedIndicesPaginator
(ListAttachedIndicesRequest listAttachedIndicesRequest) This is a variant oflistAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation.Retrieves each Amazon Resource Name (ARN) of schemas in the development state.listDevelopmentSchemaArns
(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest) Retrieves each Amazon Resource Name (ARN) of schemas in the development state.listDevelopmentSchemaArns
(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest) Retrieves each Amazon Resource Name (ARN) of schemas in the development state.This is a variant oflistDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.listDevelopmentSchemaArnsPaginator
(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest) This is a variant oflistDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.listDevelopmentSchemaArnsPaginator
(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest) This is a variant oflistDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.default ListDirectoriesResponse
Lists directories created within an account.default ListDirectoriesResponse
listDirectories
(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest) Lists directories created within an account.default ListDirectoriesResponse
listDirectories
(ListDirectoriesRequest listDirectoriesRequest) Lists directories created within an account.default ListDirectoriesIterable
This is a variant oflistDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.default ListDirectoriesIterable
listDirectoriesPaginator
(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest) This is a variant oflistDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.default ListDirectoriesIterable
listDirectoriesPaginator
(ListDirectoriesRequest listDirectoriesRequest) This is a variant oflistDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.default ListFacetAttributesResponse
listFacetAttributes
(Consumer<ListFacetAttributesRequest.Builder> listFacetAttributesRequest) Retrieves attributes attached to the facet.default ListFacetAttributesResponse
listFacetAttributes
(ListFacetAttributesRequest listFacetAttributesRequest) Retrieves attributes attached to the facet.default ListFacetAttributesIterable
listFacetAttributesPaginator
(Consumer<ListFacetAttributesRequest.Builder> listFacetAttributesRequest) This is a variant oflistFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation.default ListFacetAttributesIterable
listFacetAttributesPaginator
(ListFacetAttributesRequest listFacetAttributesRequest) This is a variant oflistFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation.default ListFacetNamesResponse
listFacetNames
(Consumer<ListFacetNamesRequest.Builder> listFacetNamesRequest) Retrieves the names of facets that exist in a schema.default ListFacetNamesResponse
listFacetNames
(ListFacetNamesRequest listFacetNamesRequest) Retrieves the names of facets that exist in a schema.default ListFacetNamesIterable
listFacetNamesPaginator
(Consumer<ListFacetNamesRequest.Builder> listFacetNamesRequest) This is a variant oflistFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation.default ListFacetNamesIterable
listFacetNamesPaginator
(ListFacetNamesRequest listFacetNamesRequest) This is a variant oflistFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation.default ListIncomingTypedLinksResponse
listIncomingTypedLinks
(Consumer<ListIncomingTypedLinksRequest.Builder> listIncomingTypedLinksRequest) Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.default ListIncomingTypedLinksResponse
listIncomingTypedLinks
(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest) Returns a paginated list of all the incoming TypedLinkSpecifier information for an object.default ListIndexResponse
listIndex
(Consumer<ListIndexRequest.Builder> listIndexRequest) Lists objects attached to the specified index.default ListIndexResponse
listIndex
(ListIndexRequest listIndexRequest) Lists objects attached to the specified index.default ListIndexIterable
listIndexPaginator
(Consumer<ListIndexRequest.Builder> listIndexRequest) This is a variant oflistIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation.default ListIndexIterable
listIndexPaginator
(ListIndexRequest listIndexRequest) This is a variant oflistIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation.default ListManagedSchemaArnsResponse
Lists the major version families of each managed schema.default ListManagedSchemaArnsResponse
listManagedSchemaArns
(Consumer<ListManagedSchemaArnsRequest.Builder> listManagedSchemaArnsRequest) Lists the major version families of each managed schema.default ListManagedSchemaArnsResponse
listManagedSchemaArns
(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest) Lists the major version families of each managed schema.default ListManagedSchemaArnsIterable
This is a variant oflistManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation.default ListManagedSchemaArnsIterable
listManagedSchemaArnsPaginator
(Consumer<ListManagedSchemaArnsRequest.Builder> listManagedSchemaArnsRequest) This is a variant oflistManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation.default ListManagedSchemaArnsIterable
listManagedSchemaArnsPaginator
(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest) This is a variant oflistManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation.default ListObjectAttributesResponse
listObjectAttributes
(Consumer<ListObjectAttributesRequest.Builder> listObjectAttributesRequest) Lists all attributes that are associated with an object.default ListObjectAttributesResponse
listObjectAttributes
(ListObjectAttributesRequest listObjectAttributesRequest) Lists all attributes that are associated with an object.default ListObjectAttributesIterable
listObjectAttributesPaginator
(Consumer<ListObjectAttributesRequest.Builder> listObjectAttributesRequest) This is a variant oflistObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation.default ListObjectAttributesIterable
listObjectAttributesPaginator
(ListObjectAttributesRequest listObjectAttributesRequest) This is a variant oflistObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation.default ListObjectChildrenResponse
listObjectChildren
(Consumer<ListObjectChildrenRequest.Builder> listObjectChildrenRequest) Returns a paginated list of child objects that are associated with a given object.default ListObjectChildrenResponse
listObjectChildren
(ListObjectChildrenRequest listObjectChildrenRequest) Returns a paginated list of child objects that are associated with a given object.default ListObjectChildrenIterable
listObjectChildrenPaginator
(Consumer<ListObjectChildrenRequest.Builder> listObjectChildrenRequest) This is a variant oflistObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation.default ListObjectChildrenIterable
listObjectChildrenPaginator
(ListObjectChildrenRequest listObjectChildrenRequest) This is a variant oflistObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation.default ListObjectParentPathsResponse
listObjectParentPaths
(Consumer<ListObjectParentPathsRequest.Builder> listObjectParentPathsRequest) Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.default ListObjectParentPathsResponse
listObjectParentPaths
(ListObjectParentPathsRequest listObjectParentPathsRequest) Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node objects.default ListObjectParentPathsIterable
listObjectParentPathsPaginator
(Consumer<ListObjectParentPathsRequest.Builder> listObjectParentPathsRequest) This is a variant oflistObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation.default ListObjectParentPathsIterable
listObjectParentPathsPaginator
(ListObjectParentPathsRequest listObjectParentPathsRequest) This is a variant oflistObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation.default ListObjectParentsResponse
listObjectParents
(Consumer<ListObjectParentsRequest.Builder> listObjectParentsRequest) Lists parent objects that are associated with a given object in pagination fashion.default ListObjectParentsResponse
listObjectParents
(ListObjectParentsRequest listObjectParentsRequest) Lists parent objects that are associated with a given object in pagination fashion.default ListObjectParentsIterable
listObjectParentsPaginator
(Consumer<ListObjectParentsRequest.Builder> listObjectParentsRequest) This is a variant oflistObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation.default ListObjectParentsIterable
listObjectParentsPaginator
(ListObjectParentsRequest listObjectParentsRequest) This is a variant oflistObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation.default ListObjectPoliciesResponse
listObjectPolicies
(Consumer<ListObjectPoliciesRequest.Builder> listObjectPoliciesRequest) Returns policies attached to an object in pagination fashion.default ListObjectPoliciesResponse
listObjectPolicies
(ListObjectPoliciesRequest listObjectPoliciesRequest) Returns policies attached to an object in pagination fashion.default ListObjectPoliciesIterable
listObjectPoliciesPaginator
(Consumer<ListObjectPoliciesRequest.Builder> listObjectPoliciesRequest) This is a variant oflistObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation.default ListObjectPoliciesIterable
listObjectPoliciesPaginator
(ListObjectPoliciesRequest listObjectPoliciesRequest) This is a variant oflistObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation.default ListOutgoingTypedLinksResponse
listOutgoingTypedLinks
(Consumer<ListOutgoingTypedLinksRequest.Builder> listOutgoingTypedLinksRequest) Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.default ListOutgoingTypedLinksResponse
listOutgoingTypedLinks
(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest) Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object.default ListPolicyAttachmentsResponse
listPolicyAttachments
(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest) Returns all of theObjectIdentifiers
to which a given policy is attached.default ListPolicyAttachmentsResponse
listPolicyAttachments
(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest) Returns all of theObjectIdentifiers
to which a given policy is attached.default ListPolicyAttachmentsIterable
listPolicyAttachmentsPaginator
(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest) This is a variant oflistPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation.default ListPolicyAttachmentsIterable
listPolicyAttachmentsPaginator
(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest) This is a variant oflistPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation.default ListPublishedSchemaArnsResponse
Lists the major version families of each published schema.default ListPublishedSchemaArnsResponse
listPublishedSchemaArns
(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest) Lists the major version families of each published schema.default ListPublishedSchemaArnsResponse
listPublishedSchemaArns
(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest) Lists the major version families of each published schema.default ListPublishedSchemaArnsIterable
This is a variant oflistPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.default ListPublishedSchemaArnsIterable
listPublishedSchemaArnsPaginator
(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest) This is a variant oflistPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.default ListPublishedSchemaArnsIterable
listPublishedSchemaArnsPaginator
(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest) This is a variant oflistPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns tags for a resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns tags for a resource.default ListTagsForResourceIterable
listTagsForResourcePaginator
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation.default ListTagsForResourceIterable
listTagsForResourcePaginator
(ListTagsForResourceRequest listTagsForResourceRequest) This is a variant oflistTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation.listTypedLinkFacetAttributes
(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest) Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.listTypedLinkFacetAttributes
(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest) Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.listTypedLinkFacetAttributesPaginator
(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest) This is a variant oflistTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation.listTypedLinkFacetAttributesPaginator
(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest) This is a variant oflistTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation.default ListTypedLinkFacetNamesResponse
listTypedLinkFacetNames
(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest) Returns a paginated list ofTypedLink
facet names for a particular schema.default ListTypedLinkFacetNamesResponse
listTypedLinkFacetNames
(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest) Returns a paginated list ofTypedLink
facet names for a particular schema.default ListTypedLinkFacetNamesIterable
listTypedLinkFacetNamesPaginator
(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest) This is a variant oflistTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation.default ListTypedLinkFacetNamesIterable
listTypedLinkFacetNamesPaginator
(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest) This is a variant oflistTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation.default LookupPolicyResponse
lookupPolicy
(Consumer<LookupPolicyRequest.Builder> lookupPolicyRequest) Lists all policies from the root of the Directory to the object specified.default LookupPolicyResponse
lookupPolicy
(LookupPolicyRequest lookupPolicyRequest) Lists all policies from the root of the Directory to the object specified.default LookupPolicyIterable
lookupPolicyPaginator
(Consumer<LookupPolicyRequest.Builder> lookupPolicyRequest) This is a variant oflookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation.default LookupPolicyIterable
lookupPolicyPaginator
(LookupPolicyRequest lookupPolicyRequest) This is a variant oflookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation.default PublishSchemaResponse
publishSchema
(Consumer<PublishSchemaRequest.Builder> publishSchemaRequest) Publishes a development schema with a major version and a recommended minor version.default PublishSchemaResponse
publishSchema
(PublishSchemaRequest publishSchemaRequest) Publishes a development schema with a major version and a recommended minor version.default PutSchemaFromJsonResponse
putSchemaFromJson
(Consumer<PutSchemaFromJsonRequest.Builder> putSchemaFromJsonRequest) Allows a schema to be updated using JSON upload.default PutSchemaFromJsonResponse
putSchemaFromJson
(PutSchemaFromJsonRequest putSchemaFromJsonRequest) Allows a schema to be updated using JSON upload.default RemoveFacetFromObjectResponse
removeFacetFromObject
(Consumer<RemoveFacetFromObjectRequest.Builder> removeFacetFromObjectRequest) Removes the specified facet from the specified object.default RemoveFacetFromObjectResponse
removeFacetFromObject
(RemoveFacetFromObjectRequest removeFacetFromObjectRequest) Removes the specified facet from the specified object.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) An API operation for adding tags to a resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) An API operation for adding tags to a resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) An API operation for removing tags from a resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) An API operation for removing tags from a resource.default UpdateFacetResponse
updateFacet
(Consumer<UpdateFacetRequest.Builder> updateFacetRequest) Does the following:default UpdateFacetResponse
updateFacet
(UpdateFacetRequest updateFacetRequest) Does the following:default UpdateLinkAttributesResponse
updateLinkAttributes
(Consumer<UpdateLinkAttributesRequest.Builder> updateLinkAttributesRequest) Updates a given typed link’s attributes.default UpdateLinkAttributesResponse
updateLinkAttributes
(UpdateLinkAttributesRequest updateLinkAttributesRequest) Updates a given typed link’s attributes.default UpdateObjectAttributesResponse
updateObjectAttributes
(Consumer<UpdateObjectAttributesRequest.Builder> updateObjectAttributesRequest) Updates a given object's attributes.default UpdateObjectAttributesResponse
updateObjectAttributes
(UpdateObjectAttributesRequest updateObjectAttributesRequest) Updates a given object's attributes.default UpdateSchemaResponse
updateSchema
(Consumer<UpdateSchemaRequest.Builder> updateSchemaRequest) Updates the schema name with a new name.default UpdateSchemaResponse
updateSchema
(UpdateSchemaRequest updateSchemaRequest) Updates the schema name with a new name.default UpdateTypedLinkFacetResponse
updateTypedLinkFacet
(Consumer<UpdateTypedLinkFacetRequest.Builder> updateTypedLinkFacetRequest) Updates a TypedLinkFacet.default UpdateTypedLinkFacetResponse
updateTypedLinkFacet
(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest) Updates a TypedLinkFacet.default UpgradeAppliedSchemaResponse
upgradeAppliedSchema
(Consumer<UpgradeAppliedSchemaRequest.Builder> upgradeAppliedSchemaRequest) Upgrades a single directory in-place using thePublishedSchemaArn
with schema updates found inMinorVersion
.default UpgradeAppliedSchemaResponse
upgradeAppliedSchema
(UpgradeAppliedSchemaRequest upgradeAppliedSchemaRequest) Upgrades a single directory in-place using thePublishedSchemaArn
with schema updates found inMinorVersion
.default UpgradePublishedSchemaResponse
upgradePublishedSchema
(Consumer<UpgradePublishedSchemaRequest.Builder> upgradePublishedSchemaRequest) Upgrades a published schema under a new minor version revision using the current contents ofDevelopmentSchemaArn
.default UpgradePublishedSchemaResponse
upgradePublishedSchema
(UpgradePublishedSchemaRequest upgradePublishedSchemaRequest) Upgrades a published schema under a new minor version revision using the current contents ofDevelopmentSchemaArn
.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
addFacetToObject
default AddFacetToObjectResponse addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Adds a new Facet to an object. An object can have more than one facet applied on it.
- Parameters:
addFacetToObjectRequest
-- Returns:
- Result of the AddFacetToObject operation returned by the service.
- See Also:
-
addFacetToObject
default AddFacetToObjectResponse addFacetToObject(Consumer<AddFacetToObjectRequest.Builder> addFacetToObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Adds a new Facet to an object. An object can have more than one facet applied on it.
This is a convenience which creates an instance of the
AddFacetToObjectRequest.Builder
avoiding the need to create one manually viaAddFacetToObjectRequest.builder()
- Parameters:
addFacetToObjectRequest
- AConsumer
that will call methods onAddFacetToObjectRequest.Builder
to create a request.- Returns:
- Result of the AddFacetToObject operation returned by the service.
- See Also:
-
applySchema
default ApplySchemaResponse applySchema(ApplySchemaRequest applySchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, SchemaAlreadyExistsException, ResourceNotFoundException, InvalidAttachmentException, AwsServiceException, SdkClientException, CloudDirectoryException Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
- Parameters:
applySchemaRequest
-- Returns:
- Result of the ApplySchema operation returned by the service.
- See Also:
-
applySchema
default ApplySchemaResponse applySchema(Consumer<ApplySchemaRequest.Builder> applySchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, SchemaAlreadyExistsException, ResourceNotFoundException, InvalidAttachmentException, AwsServiceException, SdkClientException, CloudDirectoryException Copies the input published schema, at the specified version, into the Directory with the same name and version as that of the published schema.
This is a convenience which creates an instance of the
ApplySchemaRequest.Builder
avoiding the need to create one manually viaApplySchemaRequest.builder()
- Parameters:
applySchemaRequest
- AConsumer
that will call methods onApplySchemaRequest.Builder
to create a request.- Returns:
- Result of the ApplySchema operation returned by the service.
- See Also:
-
attachObject
default AttachObjectResponse attachObject(AttachObjectRequest attachObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, LinkNameAlreadyInUseException, InvalidAttachmentException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches an existing object to another object. An object can be accessed in two ways:
-
Using the path
-
Using
ObjectIdentifier
- Parameters:
attachObjectRequest
-- Returns:
- Result of the AttachObject operation returned by the service.
- See Also:
-
-
attachObject
default AttachObjectResponse attachObject(Consumer<AttachObjectRequest.Builder> attachObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, LinkNameAlreadyInUseException, InvalidAttachmentException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches an existing object to another object. An object can be accessed in two ways:
-
Using the path
-
Using
ObjectIdentifier
This is a convenience which creates an instance of the
AttachObjectRequest.Builder
avoiding the need to create one manually viaAttachObjectRequest.builder()
- Parameters:
attachObjectRequest
- AConsumer
that will call methods onAttachObjectRequest.Builder
to create a request.- Returns:
- Result of the AttachObject operation returned by the service.
- See Also:
-
-
attachPolicy
default AttachPolicyResponse attachPolicy(AttachPolicyRequest attachPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches a policy object to a regular object. An object can have a limited number of attached policies.
- Parameters:
attachPolicyRequest
-- Returns:
- Result of the AttachPolicy operation returned by the service.
- See Also:
-
attachPolicy
default AttachPolicyResponse attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches a policy object to a regular object. An object can have a limited number of attached policies.
This is a convenience which creates an instance of the
AttachPolicyRequest.Builder
avoiding the need to create one manually viaAttachPolicyRequest.builder()
- Parameters:
attachPolicyRequest
- AConsumer
that will call methods onAttachPolicyRequest.Builder
to create a request.- Returns:
- Result of the AttachPolicy operation returned by the service.
- See Also:
-
attachToIndex
default AttachToIndexResponse attachToIndex(AttachToIndexRequest attachToIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidAttachmentException, ResourceNotFoundException, LinkNameAlreadyInUseException, IndexedAttributeMissingException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches the specified object to the specified index.
- Parameters:
attachToIndexRequest
-- Returns:
- Result of the AttachToIndex operation returned by the service.
- See Also:
-
attachToIndex
default AttachToIndexResponse attachToIndex(Consumer<AttachToIndexRequest.Builder> attachToIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidAttachmentException, ResourceNotFoundException, LinkNameAlreadyInUseException, IndexedAttributeMissingException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches the specified object to the specified index.
This is a convenience which creates an instance of the
AttachToIndexRequest.Builder
avoiding the need to create one manually viaAttachToIndexRequest.builder()
- Parameters:
attachToIndexRequest
- AConsumer
that will call methods onAttachToIndexRequest.Builder
to create a request.- Returns:
- Result of the AttachToIndex operation returned by the service.
- See Also:
-
attachTypedLink
default AttachTypedLinkResponse attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidAttachmentException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches a typed link to a specified source and target object. For more information, see Typed Links.
- Parameters:
attachTypedLinkRequest
-- Returns:
- Result of the AttachTypedLink operation returned by the service.
- See Also:
-
attachTypedLink
default AttachTypedLinkResponse attachTypedLink(Consumer<AttachTypedLinkRequest.Builder> attachTypedLinkRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidAttachmentException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Attaches a typed link to a specified source and target object. For more information, see Typed Links.
This is a convenience which creates an instance of the
AttachTypedLinkRequest.Builder
avoiding the need to create one manually viaAttachTypedLinkRequest.builder()
- Parameters:
attachTypedLinkRequest
- AConsumer
that will call methods onAttachTypedLinkRequest.Builder
to create a request.- Returns:
- Result of the AttachTypedLink operation returned by the service.
- See Also:
-
batchRead
default BatchReadResponse batchRead(BatchReadRequest batchReadRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, AwsServiceException, SdkClientException, CloudDirectoryException Performs all the read operations in a batch.
- Parameters:
batchReadRequest
-- Returns:
- Result of the BatchRead operation returned by the service.
- See Also:
-
batchRead
default BatchReadResponse batchRead(Consumer<BatchReadRequest.Builder> batchReadRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, AwsServiceException, SdkClientException, CloudDirectoryException Performs all the read operations in a batch.
This is a convenience which creates an instance of the
BatchReadRequest.Builder
avoiding the need to create one manually viaBatchReadRequest.builder()
- Parameters:
batchReadRequest
- AConsumer
that will call methods onBatchReadRequest.Builder
to create a request.- Returns:
- Result of the BatchRead operation returned by the service.
- See Also:
-
batchWrite
default BatchWriteResponse batchWrite(BatchWriteRequest batchWriteRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, BatchWriteException, AwsServiceException, SdkClientException, CloudDirectoryException Performs all the write operations in a batch. Either all the operations succeed or none.
- Parameters:
batchWriteRequest
-- Returns:
- Result of the BatchWrite operation returned by the service.
- See Also:
-
batchWrite
default BatchWriteResponse batchWrite(Consumer<BatchWriteRequest.Builder> batchWriteRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, BatchWriteException, AwsServiceException, SdkClientException, CloudDirectoryException Performs all the write operations in a batch. Either all the operations succeed or none.
This is a convenience which creates an instance of the
BatchWriteRequest.Builder
avoiding the need to create one manually viaBatchWriteRequest.builder()
- Parameters:
batchWriteRequest
- AConsumer
that will call methods onBatchWriteRequest.Builder
to create a request.- Returns:
- Result of the BatchWrite operation returned by the service.
- See Also:
-
createDirectory
default CreateDirectoryResponse createDirectory(CreateDirectoryRequest createDirectoryRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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.- Parameters:
createDirectoryRequest
-- Returns:
- Result of the CreateDirectory operation returned by the service.
- See Also:
-
createDirectory
default CreateDirectoryResponse createDirectory(Consumer<CreateDirectoryRequest.Builder> createDirectoryRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryAlreadyExistsException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
CreateDirectoryRequest.Builder
avoiding the need to create one manually viaCreateDirectoryRequest.builder()
- Parameters:
createDirectoryRequest
- AConsumer
that will call methods onCreateDirectoryRequest.Builder
to create a request.- Returns:
- Result of the CreateDirectory operation returned by the service.
- See Also:
-
createFacet
default CreateFacetResponse createFacet(CreateFacetRequest createFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetAlreadyExistsException, InvalidRuleException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
- Parameters:
createFacetRequest
-- Returns:
- Result of the CreateFacet operation returned by the service.
- See Also:
-
createFacet
default CreateFacetResponse createFacet(Consumer<CreateFacetRequest.Builder> createFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetAlreadyExistsException, InvalidRuleException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Creates a new Facet in a schema. Facet creation is allowed only in development or applied schemas.
This is a convenience which creates an instance of the
CreateFacetRequest.Builder
avoiding the need to create one manually viaCreateFacetRequest.builder()
- Parameters:
createFacetRequest
- AConsumer
that will call methods onCreateFacetRequest.Builder
to create a request.- Returns:
- Result of the CreateFacet operation returned by the service.
- See Also:
-
createIndex
default CreateIndexResponse createIndex(CreateIndexRequest createIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, LinkNameAlreadyInUseException, UnsupportedIndexTypeException, AwsServiceException, SdkClientException, CloudDirectoryException Creates an index object. See Indexing and search for more information.
- Parameters:
createIndexRequest
-- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
createIndex
default CreateIndexResponse createIndex(Consumer<CreateIndexRequest.Builder> createIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, LinkNameAlreadyInUseException, UnsupportedIndexTypeException, AwsServiceException, SdkClientException, CloudDirectoryException Creates an index object. See Indexing and search for more information.
This is a convenience which creates an instance of the
CreateIndexRequest.Builder
avoiding the need to create one manually viaCreateIndexRequest.builder()
- Parameters:
createIndexRequest
- AConsumer
that will call methods onCreateIndexRequest.Builder
to create a request.- Returns:
- Result of the CreateIndex operation returned by the service.
- See Also:
-
createObject
default CreateObjectResponse createObject(CreateObjectRequest createObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, LinkNameAlreadyInUseException, UnsupportedIndexTypeException, AwsServiceException, SdkClientException, CloudDirectoryException 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.- Parameters:
createObjectRequest
-- Returns:
- Result of the CreateObject operation returned by the service.
- See Also:
-
createObject
default CreateObjectResponse createObject(Consumer<CreateObjectRequest.Builder> createObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, LinkNameAlreadyInUseException, UnsupportedIndexTypeException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
CreateObjectRequest.Builder
avoiding the need to create one manually viaCreateObjectRequest.builder()
- Parameters:
createObjectRequest
- AConsumer
that will call methods onCreateObjectRequest.Builder
to create a request.- Returns:
- Result of the CreateObject operation returned by the service.
- See Also:
-
createSchema
default CreateSchemaResponse createSchema(CreateSchemaRequest createSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, SchemaAlreadyExistsException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
- Parameters:
createSchemaRequest
-- Returns:
- Result of the CreateSchema operation returned by the service.
- See Also:
-
-
createSchema
default CreateSchemaResponse createSchema(Consumer<CreateSchemaRequest.Builder> createSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, SchemaAlreadyExistsException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
CreateSchemaRequest.Builder
avoiding the need to create one manually viaCreateSchemaRequest.builder()
- Parameters:
createSchemaRequest
- AConsumer
that will call methods onCreateSchemaRequest.Builder
to create a request.- Returns:
- Result of the CreateSchema operation returned by the service.
- See Also:
-
-
createTypedLinkFacet
default CreateTypedLinkFacetResponse createTypedLinkFacet(CreateTypedLinkFacetRequest createTypedLinkFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetAlreadyExistsException, InvalidRuleException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Creates a TypedLinkFacet. For more information, see Typed Links.
- Parameters:
createTypedLinkFacetRequest
-- Returns:
- Result of the CreateTypedLinkFacet operation returned by the service.
- See Also:
-
createTypedLinkFacet
default CreateTypedLinkFacetResponse createTypedLinkFacet(Consumer<CreateTypedLinkFacetRequest.Builder> createTypedLinkFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetAlreadyExistsException, InvalidRuleException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Creates a TypedLinkFacet. For more information, see Typed Links.
This is a convenience which creates an instance of the
CreateTypedLinkFacetRequest.Builder
avoiding the need to create one manually viaCreateTypedLinkFacetRequest.builder()
- Parameters:
createTypedLinkFacetRequest
- AConsumer
that will call methods onCreateTypedLinkFacetRequest.Builder
to create a request.- Returns:
- Result of the CreateTypedLinkFacet operation returned by the service.
- See Also:
-
deleteDirectory
default DeleteDirectoryResponse deleteDirectory(DeleteDirectoryRequest deleteDirectoryRequest) throws ResourceNotFoundException, DirectoryNotDisabledException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryDeletedException, RetryableConflictException, InvalidArnException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
- Parameters:
deleteDirectoryRequest
-- Returns:
- Result of the DeleteDirectory operation returned by the service.
- See Also:
-
deleteDirectory
default DeleteDirectoryResponse deleteDirectory(Consumer<DeleteDirectoryRequest.Builder> deleteDirectoryRequest) throws ResourceNotFoundException, DirectoryNotDisabledException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryDeletedException, RetryableConflictException, InvalidArnException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a directory. Only disabled directories can be deleted. A deleted directory cannot be undone. Exercise extreme caution when deleting directories.
This is a convenience which creates an instance of the
DeleteDirectoryRequest.Builder
avoiding the need to create one manually viaDeleteDirectoryRequest.builder()
- Parameters:
deleteDirectoryRequest
- AConsumer
that will call methods onDeleteDirectoryRequest.Builder
to create a request.- Returns:
- Result of the DeleteDirectory operation returned by the service.
- See Also:
-
deleteFacet
default DeleteFacetResponse deleteFacet(DeleteFacetRequest deleteFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, FacetInUseException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
- Parameters:
deleteFacetRequest
-- Returns:
- Result of the DeleteFacet operation returned by the service.
- See Also:
-
deleteFacet
default DeleteFacetResponse deleteFacet(Consumer<DeleteFacetRequest.Builder> deleteFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, FacetInUseException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a given Facet. All attributes and Rules that are associated with the facet will be deleted. Only development schema facets are allowed deletion.
This is a convenience which creates an instance of the
DeleteFacetRequest.Builder
avoiding the need to create one manually viaDeleteFacetRequest.builder()
- Parameters:
deleteFacetRequest
- AConsumer
that will call methods onDeleteFacetRequest.Builder
to create a request.- Returns:
- Result of the DeleteFacet operation returned by the service.
- See Also:
-
deleteObject
default DeleteObjectResponse deleteObject(DeleteObjectRequest deleteObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, ObjectNotDetachedException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
- Parameters:
deleteObjectRequest
-- Returns:
- Result of the DeleteObject operation returned by the service.
- See Also:
-
deleteObject
default DeleteObjectResponse deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, ObjectNotDetachedException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
DeleteObjectRequest.Builder
avoiding the need to create one manually viaDeleteObjectRequest.builder()
- Parameters:
deleteObjectRequest
- AConsumer
that will call methods onDeleteObjectRequest.Builder
to create a request.- Returns:
- Result of the DeleteObject operation returned by the service.
- See Also:
-
deleteSchema
default DeleteSchemaResponse deleteSchema(DeleteSchemaRequest deleteSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, StillContainsLinksException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a given schema. Schemas in a development and published state can only be deleted.
- Parameters:
deleteSchemaRequest
-- Returns:
- Result of the DeleteSchema operation returned by the service.
- See Also:
-
deleteSchema
default DeleteSchemaResponse deleteSchema(Consumer<DeleteSchemaRequest.Builder> deleteSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, StillContainsLinksException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a given schema. Schemas in a development and published state can only be deleted.
This is a convenience which creates an instance of the
DeleteSchemaRequest.Builder
avoiding the need to create one manually viaDeleteSchemaRequest.builder()
- Parameters:
deleteSchemaRequest
- AConsumer
that will call methods onDeleteSchemaRequest.Builder
to create a request.- Returns:
- Result of the DeleteSchema operation returned by the service.
- See Also:
-
deleteTypedLinkFacet
default DeleteTypedLinkFacetResponse deleteTypedLinkFacet(DeleteTypedLinkFacetRequest deleteTypedLinkFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a TypedLinkFacet. For more information, see Typed Links.
- Parameters:
deleteTypedLinkFacetRequest
-- Returns:
- Result of the DeleteTypedLinkFacet operation returned by the service.
- See Also:
-
deleteTypedLinkFacet
default DeleteTypedLinkFacetResponse deleteTypedLinkFacet(Consumer<DeleteTypedLinkFacetRequest.Builder> deleteTypedLinkFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Deletes a TypedLinkFacet. For more information, see Typed Links.
This is a convenience which creates an instance of the
DeleteTypedLinkFacetRequest.Builder
avoiding the need to create one manually viaDeleteTypedLinkFacetRequest.builder()
- Parameters:
deleteTypedLinkFacetRequest
- AConsumer
that will call methods onDeleteTypedLinkFacetRequest.Builder
to create a request.- Returns:
- Result of the DeleteTypedLinkFacet operation returned by the service.
- See Also:
-
detachFromIndex
default DetachFromIndexResponse detachFromIndex(DetachFromIndexRequest detachFromIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, ObjectAlreadyDetachedException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches the specified object from the specified index.
- Parameters:
detachFromIndexRequest
-- Returns:
- Result of the DetachFromIndex operation returned by the service.
- See Also:
-
detachFromIndex
default DetachFromIndexResponse detachFromIndex(Consumer<DetachFromIndexRequest.Builder> detachFromIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, ObjectAlreadyDetachedException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches the specified object from the specified index.
This is a convenience which creates an instance of the
DetachFromIndexRequest.Builder
avoiding the need to create one manually viaDetachFromIndexRequest.builder()
- Parameters:
detachFromIndexRequest
- AConsumer
that will call methods onDetachFromIndexRequest.Builder
to create a request.- Returns:
- Result of the DetachFromIndex operation returned by the service.
- See Also:
-
detachObject
default DetachObjectResponse detachObject(DetachObjectRequest detachObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotNodeException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
- Parameters:
detachObjectRequest
-- Returns:
- Result of the DetachObject operation returned by the service.
- See Also:
-
detachObject
default DetachObjectResponse detachObject(Consumer<DetachObjectRequest.Builder> detachObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotNodeException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches a given object from the parent object. The object that is to be detached from the parent is specified by the link name.
This is a convenience which creates an instance of the
DetachObjectRequest.Builder
avoiding the need to create one manually viaDetachObjectRequest.builder()
- Parameters:
detachObjectRequest
- AConsumer
that will call methods onDetachObjectRequest.Builder
to create a request.- Returns:
- Result of the DetachObject operation returned by the service.
- See Also:
-
detachPolicy
default DetachPolicyResponse detachPolicy(DetachPolicyRequest detachPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches a policy from an object.
- Parameters:
detachPolicyRequest
-- Returns:
- Result of the DetachPolicy operation returned by the service.
- See Also:
-
detachPolicy
default DetachPolicyResponse detachPolicy(Consumer<DetachPolicyRequest.Builder> detachPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches a policy from an object.
This is a convenience which creates an instance of the
DetachPolicyRequest.Builder
avoiding the need to create one manually viaDetachPolicyRequest.builder()
- Parameters:
detachPolicyRequest
- AConsumer
that will call methods onDetachPolicyRequest.Builder
to create a request.- Returns:
- Result of the DetachPolicy operation returned by the service.
- See Also:
-
detachTypedLink
default DetachTypedLinkResponse detachTypedLink(DetachTypedLinkRequest detachTypedLinkRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches a typed link from a specified source and target object. For more information, see Typed Links.
- Parameters:
detachTypedLinkRequest
-- Returns:
- Result of the DetachTypedLink operation returned by the service.
- See Also:
-
detachTypedLink
default DetachTypedLinkResponse detachTypedLink(Consumer<DetachTypedLinkRequest.Builder> detachTypedLinkRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Detaches a typed link from a specified source and target object. For more information, see Typed Links.
This is a convenience which creates an instance of the
DetachTypedLinkRequest.Builder
avoiding the need to create one manually viaDetachTypedLinkRequest.builder()
- Parameters:
detachTypedLinkRequest
- AConsumer
that will call methods onDetachTypedLinkRequest.Builder
to create a request.- Returns:
- Result of the DetachTypedLink operation returned by the service.
- See Also:
-
disableDirectory
default DisableDirectoryResponse disableDirectory(DisableDirectoryRequest disableDirectoryRequest) throws ResourceNotFoundException, DirectoryDeletedException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, RetryableConflictException, InvalidArnException, AwsServiceException, SdkClientException, CloudDirectoryException Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
- Parameters:
disableDirectoryRequest
-- Returns:
- Result of the DisableDirectory operation returned by the service.
- See Also:
-
disableDirectory
default DisableDirectoryResponse disableDirectory(Consumer<DisableDirectoryRequest.Builder> disableDirectoryRequest) throws ResourceNotFoundException, DirectoryDeletedException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, RetryableConflictException, InvalidArnException, AwsServiceException, SdkClientException, CloudDirectoryException Disables the specified directory. Disabled directories cannot be read or written to. Only enabled directories can be disabled. Disabled directories may be reenabled.
This is a convenience which creates an instance of the
DisableDirectoryRequest.Builder
avoiding the need to create one manually viaDisableDirectoryRequest.builder()
- Parameters:
disableDirectoryRequest
- AConsumer
that will call methods onDisableDirectoryRequest.Builder
to create a request.- Returns:
- Result of the DisableDirectory operation returned by the service.
- See Also:
-
enableDirectory
default EnableDirectoryResponse enableDirectory(EnableDirectoryRequest enableDirectoryRequest) throws ResourceNotFoundException, DirectoryDeletedException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, RetryableConflictException, InvalidArnException, AwsServiceException, SdkClientException, CloudDirectoryException Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
- Parameters:
enableDirectoryRequest
-- Returns:
- Result of the EnableDirectory operation returned by the service.
- See Also:
-
enableDirectory
default EnableDirectoryResponse enableDirectory(Consumer<EnableDirectoryRequest.Builder> enableDirectoryRequest) throws ResourceNotFoundException, DirectoryDeletedException, InternalServiceException, ValidationException, LimitExceededException, AccessDeniedException, RetryableConflictException, InvalidArnException, AwsServiceException, SdkClientException, CloudDirectoryException Enables the specified directory. Only disabled directories can be enabled. Once enabled, the directory can then be read and written to.
This is a convenience which creates an instance of the
EnableDirectoryRequest.Builder
avoiding the need to create one manually viaEnableDirectoryRequest.builder()
- Parameters:
enableDirectoryRequest
- AConsumer
that will call methods onEnableDirectoryRequest.Builder
to create a request.- Returns:
- Result of the EnableDirectory operation returned by the service.
- See Also:
-
getAppliedSchemaVersion
default GetAppliedSchemaVersionResponse getAppliedSchemaVersion(GetAppliedSchemaVersionRequest getAppliedSchemaVersionRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Returns current applied schema version ARN, including the minor version in use.
- Parameters:
getAppliedSchemaVersionRequest
-- Returns:
- Result of the GetAppliedSchemaVersion operation returned by the service.
- See Also:
-
getAppliedSchemaVersion
default GetAppliedSchemaVersionResponse getAppliedSchemaVersion(Consumer<GetAppliedSchemaVersionRequest.Builder> getAppliedSchemaVersionRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Returns current applied schema version ARN, including the minor version in use.
This is a convenience which creates an instance of the
GetAppliedSchemaVersionRequest.Builder
avoiding the need to create one manually viaGetAppliedSchemaVersionRequest.builder()
- Parameters:
getAppliedSchemaVersionRequest
- AConsumer
that will call methods onGetAppliedSchemaVersionRequest.Builder
to create a request.- Returns:
- Result of the GetAppliedSchemaVersion operation returned by the service.
- See Also:
-
getDirectory
default GetDirectoryResponse getDirectory(GetDirectoryRequest getDirectoryRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves metadata about a directory.
- Parameters:
getDirectoryRequest
-- Returns:
- Result of the GetDirectory operation returned by the service.
- See Also:
-
getDirectory
default GetDirectoryResponse getDirectory(Consumer<GetDirectoryRequest.Builder> getDirectoryRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves metadata about a directory.
This is a convenience which creates an instance of the
GetDirectoryRequest.Builder
avoiding the need to create one manually viaGetDirectoryRequest.builder()
- Parameters:
getDirectoryRequest
- AConsumer
that will call methods onGetDirectoryRequest.Builder
to create a request.- Returns:
- Result of the GetDirectory operation returned by the service.
- See Also:
-
getFacet
default GetFacetResponse getFacet(GetFacetRequest getFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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.- Parameters:
getFacetRequest
-- Returns:
- Result of the GetFacet operation returned by the service.
- See Also:
-
getFacet
default GetFacetResponse getFacet(Consumer<GetFacetRequest.Builder> getFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
GetFacetRequest.Builder
avoiding the need to create one manually viaGetFacetRequest.builder()
- Parameters:
getFacetRequest
- AConsumer
that will call methods onGetFacetRequest.Builder
to create a request.- Returns:
- Result of the GetFacet operation returned by the service.
- See Also:
-
getLinkAttributes
default GetLinkAttributesResponse getLinkAttributes(GetLinkAttributesRequest getLinkAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves attributes that are associated with a typed link.
- Parameters:
getLinkAttributesRequest
-- Returns:
- Result of the GetLinkAttributes operation returned by the service.
- See Also:
-
getLinkAttributes
default GetLinkAttributesResponse getLinkAttributes(Consumer<GetLinkAttributesRequest.Builder> getLinkAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves attributes that are associated with a typed link.
This is a convenience which creates an instance of the
GetLinkAttributesRequest.Builder
avoiding the need to create one manually viaGetLinkAttributesRequest.builder()
- Parameters:
getLinkAttributesRequest
- AConsumer
that will call methods onGetLinkAttributesRequest.Builder
to create a request.- Returns:
- Result of the GetLinkAttributes operation returned by the service.
- See Also:
-
getObjectAttributes
default GetObjectAttributesResponse getObjectAttributes(GetObjectAttributesRequest getObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves attributes within a facet that are associated with an object.
- Parameters:
getObjectAttributesRequest
-- Returns:
- Result of the GetObjectAttributes operation returned by the service.
- See Also:
-
getObjectAttributes
default GetObjectAttributesResponse getObjectAttributes(Consumer<GetObjectAttributesRequest.Builder> getObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves attributes within a facet that are associated with an object.
This is a convenience which creates an instance of the
GetObjectAttributesRequest.Builder
avoiding the need to create one manually viaGetObjectAttributesRequest.builder()
- Parameters:
getObjectAttributesRequest
- AConsumer
that will call methods onGetObjectAttributesRequest.Builder
to create a request.- Returns:
- Result of the GetObjectAttributes operation returned by the service.
- See Also:
-
getObjectInformation
default GetObjectInformationResponse getObjectInformation(GetObjectInformationRequest getObjectInformationRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves metadata about an object.
- Parameters:
getObjectInformationRequest
-- Returns:
- Result of the GetObjectInformation operation returned by the service.
- See Also:
-
getObjectInformation
default GetObjectInformationResponse getObjectInformation(Consumer<GetObjectInformationRequest.Builder> getObjectInformationRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves metadata about an object.
This is a convenience which creates an instance of the
GetObjectInformationRequest.Builder
avoiding the need to create one manually viaGetObjectInformationRequest.builder()
- Parameters:
getObjectInformationRequest
- AConsumer
that will call methods onGetObjectInformationRequest.Builder
to create a request.- Returns:
- Result of the GetObjectInformation operation returned by the service.
- See Also:
-
getSchemaAsJson
default GetSchemaAsJsonResponse getSchemaAsJson(GetSchemaAsJsonRequest getSchemaAsJsonRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
- Parameters:
getSchemaAsJsonRequest
-- Returns:
- Result of the GetSchemaAsJson operation returned by the service.
- See Also:
-
getSchemaAsJson
default GetSchemaAsJsonResponse getSchemaAsJson(Consumer<GetSchemaAsJsonRequest.Builder> getSchemaAsJsonRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves a JSON representation of the schema. See JSON Schema Format for more information.
This is a convenience which creates an instance of the
GetSchemaAsJsonRequest.Builder
avoiding the need to create one manually viaGetSchemaAsJsonRequest.builder()
- Parameters:
getSchemaAsJsonRequest
- AConsumer
that will call methods onGetSchemaAsJsonRequest.Builder
to create a request.- Returns:
- Result of the GetSchemaAsJson operation returned by the service.
- See Also:
-
getTypedLinkFacetInformation
default GetTypedLinkFacetInformationResponse getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, FacetNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.
- Parameters:
getTypedLinkFacetInformationRequest
-- Returns:
- Result of the GetTypedLinkFacetInformation operation returned by the service.
- See Also:
-
getTypedLinkFacetInformation
default GetTypedLinkFacetInformationResponse getTypedLinkFacetInformation(Consumer<GetTypedLinkFacetInformationRequest.Builder> getTypedLinkFacetInformationRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, FacetNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Returns the identity attribute order for a specific TypedLinkFacet. For more information, see Typed Links.
This is a convenience which creates an instance of the
GetTypedLinkFacetInformationRequest.Builder
avoiding the need to create one manually viaGetTypedLinkFacetInformationRequest.builder()
- Parameters:
getTypedLinkFacetInformationRequest
- AConsumer
that will call methods onGetTypedLinkFacetInformationRequest.Builder
to create a request.- Returns:
- Result of the GetTypedLinkFacetInformation operation returned by the service.
- See Also:
-
listAppliedSchemaArns
default ListAppliedSchemaArnsResponse listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Lists schema major versions applied to a directory. If
SchemaArn
is provided, lists the minor version.- Parameters:
listAppliedSchemaArnsRequest
-- Returns:
- Result of the ListAppliedSchemaArns operation returned by the service.
- See Also:
-
listAppliedSchemaArns
default ListAppliedSchemaArnsResponse listAppliedSchemaArns(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Lists schema major versions applied to a directory. If
SchemaArn
is provided, lists the minor version.
This is a convenience which creates an instance of the
ListAppliedSchemaArnsRequest.Builder
avoiding the need to create one manually viaListAppliedSchemaArnsRequest.builder()
- Parameters:
listAppliedSchemaArnsRequest
- AConsumer
that will call methods onListAppliedSchemaArnsRequest.Builder
to create a request.- Returns:
- Result of the ListAppliedSchemaArns operation returned by the service.
- See Also:
-
listAppliedSchemaArnsPaginator
default ListAppliedSchemaArnsIterable listAppliedSchemaArnsPaginator(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client .listAppliedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation.- Parameters:
listAppliedSchemaArnsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAppliedSchemaArnsPaginator
default ListAppliedSchemaArnsIterable listAppliedSchemaArnsPaginator(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client .listAppliedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation.
This is a convenience which creates an instance of the
ListAppliedSchemaArnsRequest.Builder
avoiding the need to create one manually viaListAppliedSchemaArnsRequest.builder()
- Parameters:
listAppliedSchemaArnsRequest
- AConsumer
that will call methods onListAppliedSchemaArnsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttachedIndices
default ListAttachedIndicesResponse listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Lists indices attached to the specified object.
- Parameters:
listAttachedIndicesRequest
-- Returns:
- Result of the ListAttachedIndices operation returned by the service.
- See Also:
-
listAttachedIndices
default ListAttachedIndicesResponse listAttachedIndices(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Lists indices attached to the specified object.
This is a convenience which creates an instance of the
ListAttachedIndicesRequest.Builder
avoiding the need to create one manually viaListAttachedIndicesRequest.builder()
- Parameters:
listAttachedIndicesRequest
- AConsumer
that will call methods onListAttachedIndicesRequest.Builder
to create a request.- Returns:
- Result of the ListAttachedIndices operation returned by the service.
- See Also:
-
listAttachedIndicesPaginator
default ListAttachedIndicesIterable listAttachedIndicesPaginator(ListAttachedIndicesRequest listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client .listAttachedIndicesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation.- Parameters:
listAttachedIndicesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listAttachedIndicesPaginator
default ListAttachedIndicesIterable listAttachedIndicesPaginator(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client .listAttachedIndicesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation.
This is a convenience which creates an instance of the
ListAttachedIndicesRequest.Builder
avoiding the need to create one manually viaListAttachedIndicesRequest.builder()
- Parameters:
listAttachedIndicesRequest
- AConsumer
that will call methods onListAttachedIndicesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDevelopmentSchemaArns
default ListDevelopmentSchemaArnsResponse listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
- Parameters:
listDevelopmentSchemaArnsRequest
-- Returns:
- Result of the ListDevelopmentSchemaArns operation returned by the service.
- See Also:
-
listDevelopmentSchemaArns
default ListDevelopmentSchemaArnsResponse listDevelopmentSchemaArns(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
This is a convenience which creates an instance of the
ListDevelopmentSchemaArnsRequest.Builder
avoiding the need to create one manually viaListDevelopmentSchemaArnsRequest.builder()
- Parameters:
listDevelopmentSchemaArnsRequest
- AConsumer
that will call methods onListDevelopmentSchemaArnsRequest.Builder
to create a request.- Returns:
- Result of the ListDevelopmentSchemaArns operation returned by the service.
- See Also:
-
listDevelopmentSchemaArns
default ListDevelopmentSchemaArnsResponse listDevelopmentSchemaArns() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionRetrieves each Amazon Resource Name (ARN) of schemas in the development state.
- Returns:
- Result of the ListDevelopmentSchemaArns operation returned by the service.
- See Also:
-
listDevelopmentSchemaArnsPaginator
default ListDevelopmentSchemaArnsIterable listDevelopmentSchemaArnsPaginator() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionThis is a variant of
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client .listDevelopmentSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDevelopmentSchemaArnsPaginator
default ListDevelopmentSchemaArnsIterable listDevelopmentSchemaArnsPaginator(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client .listDevelopmentSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.- Parameters:
listDevelopmentSchemaArnsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDevelopmentSchemaArnsPaginator
default ListDevelopmentSchemaArnsIterable listDevelopmentSchemaArnsPaginator(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client .listDevelopmentSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.
This is a convenience which creates an instance of the
ListDevelopmentSchemaArnsRequest.Builder
avoiding the need to create one manually viaListDevelopmentSchemaArnsRequest.builder()
- Parameters:
listDevelopmentSchemaArnsRequest
- AConsumer
that will call methods onListDevelopmentSchemaArnsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDirectories
default ListDirectoriesResponse listDirectories(ListDirectoriesRequest listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Lists directories created within an account.
- Parameters:
listDirectoriesRequest
-- Returns:
- Result of the ListDirectories operation returned by the service.
- See Also:
-
listDirectories
default ListDirectoriesResponse listDirectories(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Lists directories created within an account.
This is a convenience which creates an instance of the
ListDirectoriesRequest.Builder
avoiding the need to create one manually viaListDirectoriesRequest.builder()
- Parameters:
listDirectoriesRequest
- AConsumer
that will call methods onListDirectoriesRequest.Builder
to create a request.- Returns:
- Result of the ListDirectories operation returned by the service.
- See Also:
-
listDirectories
default ListDirectoriesResponse listDirectories() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionLists directories created within an account.
- Returns:
- Result of the ListDirectories operation returned by the service.
- See Also:
-
listDirectoriesPaginator
default ListDirectoriesIterable listDirectoriesPaginator() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionThis is a variant of
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client .listDirectoriesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDirectoriesPaginator
default ListDirectoriesIterable listDirectoriesPaginator(ListDirectoriesRequest listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client .listDirectoriesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.- Parameters:
listDirectoriesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDirectoriesPaginator
default ListDirectoriesIterable listDirectoriesPaginator(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client .listDirectoriesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.
This is a convenience which creates an instance of the
ListDirectoriesRequest.Builder
avoiding the need to create one manually viaListDirectoriesRequest.builder()
- Parameters:
listDirectoriesRequest
- AConsumer
that will call methods onListDirectoriesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFacetAttributes
default ListFacetAttributesResponse listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves attributes attached to the facet.
- Parameters:
listFacetAttributesRequest
-- Returns:
- Result of the ListFacetAttributes operation returned by the service.
- See Also:
-
listFacetAttributes
default ListFacetAttributesResponse listFacetAttributes(Consumer<ListFacetAttributesRequest.Builder> listFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves attributes attached to the facet.
This is a convenience which creates an instance of the
ListFacetAttributesRequest.Builder
avoiding the need to create one manually viaListFacetAttributesRequest.builder()
- Parameters:
listFacetAttributesRequest
- AConsumer
that will call methods onListFacetAttributesRequest.Builder
to create a request.- Returns:
- Result of the ListFacetAttributes operation returned by the service.
- See Also:
-
listFacetAttributesPaginator
default ListFacetAttributesIterable listFacetAttributesPaginator(ListFacetAttributesRequest listFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client .listFacetAttributesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation.- Parameters:
listFacetAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFacetAttributesPaginator
default ListFacetAttributesIterable listFacetAttributesPaginator(Consumer<ListFacetAttributesRequest.Builder> listFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client .listFacetAttributesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation.
This is a convenience which creates an instance of the
ListFacetAttributesRequest.Builder
avoiding the need to create one manually viaListFacetAttributesRequest.builder()
- Parameters:
listFacetAttributesRequest
- AConsumer
that will call methods onListFacetAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFacetNames
default ListFacetNamesResponse listFacetNames(ListFacetNamesRequest listFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves the names of facets that exist in a schema.
- Parameters:
listFacetNamesRequest
-- Returns:
- Result of the ListFacetNames operation returned by the service.
- See Also:
-
listFacetNames
default ListFacetNamesResponse listFacetNames(Consumer<ListFacetNamesRequest.Builder> listFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Retrieves the names of facets that exist in a schema.
This is a convenience which creates an instance of the
ListFacetNamesRequest.Builder
avoiding the need to create one manually viaListFacetNamesRequest.builder()
- Parameters:
listFacetNamesRequest
- AConsumer
that will call methods onListFacetNamesRequest.Builder
to create a request.- Returns:
- Result of the ListFacetNames operation returned by the service.
- See Also:
-
listFacetNamesPaginator
default ListFacetNamesIterable listFacetNamesPaginator(ListFacetNamesRequest listFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client .listFacetNamesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation.- Parameters:
listFacetNamesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFacetNamesPaginator
default ListFacetNamesIterable listFacetNamesPaginator(Consumer<ListFacetNamesRequest.Builder> listFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client .listFacetNamesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation.
This is a convenience which creates an instance of the
ListFacetNamesRequest.Builder
avoiding the need to create one manually viaListFacetNamesRequest.builder()
- Parameters:
listFacetNamesRequest
- AConsumer
that will call methods onListFacetNamesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIncomingTypedLinks
default ListIncomingTypedLinksResponse listIncomingTypedLinks(ListIncomingTypedLinksRequest listIncomingTypedLinksRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
- Parameters:
listIncomingTypedLinksRequest
-- Returns:
- Result of the ListIncomingTypedLinks operation returned by the service.
- See Also:
-
listIncomingTypedLinks
default ListIncomingTypedLinksResponse listIncomingTypedLinks(Consumer<ListIncomingTypedLinksRequest.Builder> listIncomingTypedLinksRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
ListIncomingTypedLinksRequest.Builder
avoiding the need to create one manually viaListIncomingTypedLinksRequest.builder()
- Parameters:
listIncomingTypedLinksRequest
- AConsumer
that will call methods onListIncomingTypedLinksRequest.Builder
to create a request.- Returns:
- Result of the ListIncomingTypedLinks operation returned by the service.
- See Also:
-
listIndex
default ListIndexResponse listIndex(ListIndexRequest listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, FacetValidationException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException Lists objects attached to the specified index.
- Parameters:
listIndexRequest
-- Returns:
- Result of the ListIndex operation returned by the service.
- See Also:
-
listIndex
default ListIndexResponse listIndex(Consumer<ListIndexRequest.Builder> listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, FacetValidationException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException Lists objects attached to the specified index.
This is a convenience which creates an instance of the
ListIndexRequest.Builder
avoiding the need to create one manually viaListIndexRequest.builder()
- Parameters:
listIndexRequest
- AConsumer
that will call methods onListIndexRequest.Builder
to create a request.- Returns:
- Result of the ListIndex operation returned by the service.
- See Also:
-
listIndexPaginator
default ListIndexIterable listIndexPaginator(ListIndexRequest listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, FacetValidationException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListIndexResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation.- Parameters:
listIndexRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listIndexPaginator
default ListIndexIterable listIndexPaginator(Consumer<ListIndexRequest.Builder> listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, FacetValidationException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListIndexResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation.
This is a convenience which creates an instance of the
ListIndexRequest.Builder
avoiding the need to create one manually viaListIndexRequest.builder()
- Parameters:
listIndexRequest
- AConsumer
that will call methods onListIndexRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedSchemaArns
default ListManagedSchemaArnsResponse listManagedSchemaArns(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
- Parameters:
listManagedSchemaArnsRequest
-- Returns:
- Result of the ListManagedSchemaArns operation returned by the service.
- See Also:
-
listManagedSchemaArns
default ListManagedSchemaArnsResponse listManagedSchemaArns(Consumer<ListManagedSchemaArnsRequest.Builder> listManagedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
ListManagedSchemaArnsRequest.Builder
avoiding the need to create one manually viaListManagedSchemaArnsRequest.builder()
- Parameters:
listManagedSchemaArnsRequest
- AConsumer
that will call methods onListManagedSchemaArnsRequest.Builder
to create a request.- Returns:
- Result of the ListManagedSchemaArns operation returned by the service.
- See Also:
-
listManagedSchemaArns
default ListManagedSchemaArnsResponse listManagedSchemaArns() throws InternalServiceException, InvalidArnException, ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionLists the major version families of each managed schema. If a major version ARN is provided as SchemaArn, the minor version revisions in that family are listed instead.
- Returns:
- Result of the ListManagedSchemaArns operation returned by the service.
- See Also:
-
listManagedSchemaArnsPaginator
default ListManagedSchemaArnsIterable listManagedSchemaArnsPaginator() throws InternalServiceException, InvalidArnException, ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionThis is a variant of
listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client.listManagedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client .listManagedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client.listManagedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedSchemaArnsPaginator
default ListManagedSchemaArnsIterable listManagedSchemaArnsPaginator(ListManagedSchemaArnsRequest listManagedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client.listManagedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client .listManagedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client.listManagedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation.- Parameters:
listManagedSchemaArnsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedSchemaArnsPaginator
default ListManagedSchemaArnsIterable listManagedSchemaArnsPaginator(Consumer<ListManagedSchemaArnsRequest.Builder> listManagedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, ValidationException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client.listManagedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client .listManagedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListManagedSchemaArnsIterable responses = client.listManagedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listManagedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListManagedSchemaArnsRequest)
operation.
This is a convenience which creates an instance of the
ListManagedSchemaArnsRequest.Builder
avoiding the need to create one manually viaListManagedSchemaArnsRequest.builder()
- Parameters:
listManagedSchemaArnsRequest
- AConsumer
that will call methods onListManagedSchemaArnsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectAttributes
default ListObjectAttributesResponse listObjectAttributes(ListObjectAttributesRequest listObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Lists all attributes that are associated with an object.
- Parameters:
listObjectAttributesRequest
-- Returns:
- Result of the ListObjectAttributes operation returned by the service.
- See Also:
-
listObjectAttributes
default ListObjectAttributesResponse listObjectAttributes(Consumer<ListObjectAttributesRequest.Builder> listObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Lists all attributes that are associated with an object.
This is a convenience which creates an instance of the
ListObjectAttributesRequest.Builder
avoiding the need to create one manually viaListObjectAttributesRequest.builder()
- Parameters:
listObjectAttributesRequest
- AConsumer
that will call methods onListObjectAttributesRequest.Builder
to create a request.- Returns:
- Result of the ListObjectAttributes operation returned by the service.
- See Also:
-
listObjectAttributesPaginator
default ListObjectAttributesIterable listObjectAttributesPaginator(ListObjectAttributesRequest listObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client .listObjectAttributesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation.- Parameters:
listObjectAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectAttributesPaginator
default ListObjectAttributesIterable listObjectAttributesPaginator(Consumer<ListObjectAttributesRequest.Builder> listObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client .listObjectAttributesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation.
This is a convenience which creates an instance of the
ListObjectAttributesRequest.Builder
avoiding the need to create one manually viaListObjectAttributesRequest.builder()
- Parameters:
listObjectAttributesRequest
- AConsumer
that will call methods onListObjectAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectChildren
default ListObjectChildrenResponse listObjectChildren(ListObjectChildrenRequest listObjectChildrenRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, NotNodeException, AwsServiceException, SdkClientException, CloudDirectoryException Returns a paginated list of child objects that are associated with a given object.
- Parameters:
listObjectChildrenRequest
-- Returns:
- Result of the ListObjectChildren operation returned by the service.
- See Also:
-
listObjectChildren
default ListObjectChildrenResponse listObjectChildren(Consumer<ListObjectChildrenRequest.Builder> listObjectChildrenRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, NotNodeException, AwsServiceException, SdkClientException, CloudDirectoryException Returns a paginated list of child objects that are associated with a given object.
This is a convenience which creates an instance of the
ListObjectChildrenRequest.Builder
avoiding the need to create one manually viaListObjectChildrenRequest.builder()
- Parameters:
listObjectChildrenRequest
- AConsumer
that will call methods onListObjectChildrenRequest.Builder
to create a request.- Returns:
- Result of the ListObjectChildren operation returned by the service.
- See Also:
-
listObjectChildrenPaginator
default ListObjectChildrenIterable listObjectChildrenPaginator(ListObjectChildrenRequest listObjectChildrenRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, NotNodeException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client .listObjectChildrenPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation.- Parameters:
listObjectChildrenRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectChildrenPaginator
default ListObjectChildrenIterable listObjectChildrenPaginator(Consumer<ListObjectChildrenRequest.Builder> listObjectChildrenRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, NotNodeException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client .listObjectChildrenPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation.
This is a convenience which creates an instance of the
ListObjectChildrenRequest.Builder
avoiding the need to create one manually viaListObjectChildrenRequest.builder()
- Parameters:
listObjectChildrenRequest
- AConsumer
that will call methods onListObjectChildrenRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectParentPaths
default ListObjectParentPathsResponse listObjectParentPaths(ListObjectParentPathsRequest listObjectParentPathsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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.- Parameters:
listObjectParentPathsRequest
-- Returns:
- Result of the ListObjectParentPaths operation returned by the service.
- See Also:
-
listObjectParentPaths
default ListObjectParentPathsResponse listObjectParentPaths(Consumer<ListObjectParentPathsRequest.Builder> listObjectParentPathsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
ListObjectParentPathsRequest.Builder
avoiding the need to create one manually viaListObjectParentPathsRequest.builder()
- Parameters:
listObjectParentPathsRequest
- AConsumer
that will call methods onListObjectParentPathsRequest.Builder
to create a request.- Returns:
- Result of the ListObjectParentPaths operation returned by the service.
- See Also:
-
listObjectParentPathsPaginator
default ListObjectParentPathsIterable listObjectParentPathsPaginator(ListObjectParentPathsRequest listObjectParentPathsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client .listObjectParentPathsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation.- Parameters:
listObjectParentPathsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectParentPathsPaginator
default ListObjectParentPathsIterable listObjectParentPathsPaginator(Consumer<ListObjectParentPathsRequest.Builder> listObjectParentPathsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client .listObjectParentPathsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation.
This is a convenience which creates an instance of the
ListObjectParentPathsRequest.Builder
avoiding the need to create one manually viaListObjectParentPathsRequest.builder()
- Parameters:
listObjectParentPathsRequest
- AConsumer
that will call methods onListObjectParentPathsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectParents
default ListObjectParentsResponse listObjectParents(ListObjectParentsRequest listObjectParentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, CannotListParentOfRootException, AwsServiceException, SdkClientException, CloudDirectoryException Lists parent objects that are associated with a given object in pagination fashion.
- Parameters:
listObjectParentsRequest
-- Returns:
- Result of the ListObjectParents operation returned by the service.
- See Also:
-
listObjectParents
default ListObjectParentsResponse listObjectParents(Consumer<ListObjectParentsRequest.Builder> listObjectParentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, CannotListParentOfRootException, AwsServiceException, SdkClientException, CloudDirectoryException Lists parent objects that are associated with a given object in pagination fashion.
This is a convenience which creates an instance of the
ListObjectParentsRequest.Builder
avoiding the need to create one manually viaListObjectParentsRequest.builder()
- Parameters:
listObjectParentsRequest
- AConsumer
that will call methods onListObjectParentsRequest.Builder
to create a request.- Returns:
- Result of the ListObjectParents operation returned by the service.
- See Also:
-
listObjectParentsPaginator
default ListObjectParentsIterable listObjectParentsPaginator(ListObjectParentsRequest listObjectParentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, CannotListParentOfRootException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client .listObjectParentsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation.- Parameters:
listObjectParentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectParentsPaginator
default ListObjectParentsIterable listObjectParentsPaginator(Consumer<ListObjectParentsRequest.Builder> listObjectParentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, CannotListParentOfRootException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client .listObjectParentsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation.
This is a convenience which creates an instance of the
ListObjectParentsRequest.Builder
avoiding the need to create one manually viaListObjectParentsRequest.builder()
- Parameters:
listObjectParentsRequest
- AConsumer
that will call methods onListObjectParentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectPolicies
default ListObjectPoliciesResponse listObjectPolicies(ListObjectPoliciesRequest listObjectPoliciesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Returns policies attached to an object in pagination fashion.
- Parameters:
listObjectPoliciesRequest
-- Returns:
- Result of the ListObjectPolicies operation returned by the service.
- See Also:
-
listObjectPolicies
default ListObjectPoliciesResponse listObjectPolicies(Consumer<ListObjectPoliciesRequest.Builder> listObjectPoliciesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Returns policies attached to an object in pagination fashion.
This is a convenience which creates an instance of the
ListObjectPoliciesRequest.Builder
avoiding the need to create one manually viaListObjectPoliciesRequest.builder()
- Parameters:
listObjectPoliciesRequest
- AConsumer
that will call methods onListObjectPoliciesRequest.Builder
to create a request.- Returns:
- Result of the ListObjectPolicies operation returned by the service.
- See Also:
-
listObjectPoliciesPaginator
default ListObjectPoliciesIterable listObjectPoliciesPaginator(ListObjectPoliciesRequest listObjectPoliciesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client .listObjectPoliciesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation.- Parameters:
listObjectPoliciesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listObjectPoliciesPaginator
default ListObjectPoliciesIterable listObjectPoliciesPaginator(Consumer<ListObjectPoliciesRequest.Builder> listObjectPoliciesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client .listObjectPoliciesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation.
This is a convenience which creates an instance of the
ListObjectPoliciesRequest.Builder
avoiding the need to create one manually viaListObjectPoliciesRequest.builder()
- Parameters:
listObjectPoliciesRequest
- AConsumer
that will call methods onListObjectPoliciesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listOutgoingTypedLinks
default ListOutgoingTypedLinksResponse listOutgoingTypedLinks(ListOutgoingTypedLinksRequest listOutgoingTypedLinksRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
- Parameters:
listOutgoingTypedLinksRequest
-- Returns:
- Result of the ListOutgoingTypedLinks operation returned by the service.
- See Also:
-
listOutgoingTypedLinks
default ListOutgoingTypedLinksResponse listOutgoingTypedLinks(Consumer<ListOutgoingTypedLinksRequest.Builder> listOutgoingTypedLinksRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, InvalidNextTokenException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
ListOutgoingTypedLinksRequest.Builder
avoiding the need to create one manually viaListOutgoingTypedLinksRequest.builder()
- Parameters:
listOutgoingTypedLinksRequest
- AConsumer
that will call methods onListOutgoingTypedLinksRequest.Builder
to create a request.- Returns:
- Result of the ListOutgoingTypedLinks operation returned by the service.
- See Also:
-
listPolicyAttachments
default ListPolicyAttachmentsResponse listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException Returns all of the
ObjectIdentifiers
to which a given policy is attached.- Parameters:
listPolicyAttachmentsRequest
-- Returns:
- Result of the ListPolicyAttachments operation returned by the service.
- See Also:
-
listPolicyAttachments
default ListPolicyAttachmentsResponse listPolicyAttachments(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException Returns all of the
ObjectIdentifiers
to which a given policy is attached.
This is a convenience which creates an instance of the
ListPolicyAttachmentsRequest.Builder
avoiding the need to create one manually viaListPolicyAttachmentsRequest.builder()
- Parameters:
listPolicyAttachmentsRequest
- AConsumer
that will call methods onListPolicyAttachmentsRequest.Builder
to create a request.- Returns:
- Result of the ListPolicyAttachments operation returned by the service.
- See Also:
-
listPolicyAttachmentsPaginator
default ListPolicyAttachmentsIterable listPolicyAttachmentsPaginator(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client .listPolicyAttachmentsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation.- Parameters:
listPolicyAttachmentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPolicyAttachmentsPaginator
default ListPolicyAttachmentsIterable listPolicyAttachmentsPaginator(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client .listPolicyAttachmentsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation.
This is a convenience which creates an instance of the
ListPolicyAttachmentsRequest.Builder
avoiding the need to create one manually viaListPolicyAttachmentsRequest.builder()
- Parameters:
listPolicyAttachmentsRequest
- AConsumer
that will call methods onListPolicyAttachmentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPublishedSchemaArns
default ListPublishedSchemaArnsResponse listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException 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.- Parameters:
listPublishedSchemaArnsRequest
-- Returns:
- Result of the ListPublishedSchemaArns operation returned by the service.
- See Also:
-
listPublishedSchemaArns
default ListPublishedSchemaArnsResponse listPublishedSchemaArns(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
ListPublishedSchemaArnsRequest.Builder
avoiding the need to create one manually viaListPublishedSchemaArnsRequest.builder()
- Parameters:
listPublishedSchemaArnsRequest
- AConsumer
that will call methods onListPublishedSchemaArnsRequest.Builder
to create a request.- Returns:
- Result of the ListPublishedSchemaArns operation returned by the service.
- See Also:
-
listPublishedSchemaArns
default ListPublishedSchemaArnsResponse listPublishedSchemaArns() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionLists the major version families of each published schema. If a major version ARN is provided as
SchemaArn
, the minor version revisions in that family are listed instead.- Returns:
- Result of the ListPublishedSchemaArns operation returned by the service.
- See Also:
-
listPublishedSchemaArnsPaginator
default ListPublishedSchemaArnsIterable listPublishedSchemaArnsPaginator() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryExceptionThis is a variant of
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client .listPublishedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPublishedSchemaArnsPaginator
default ListPublishedSchemaArnsIterable listPublishedSchemaArnsPaginator(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client .listPublishedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.- Parameters:
listPublishedSchemaArnsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPublishedSchemaArnsPaginator
default ListPublishedSchemaArnsIterable listPublishedSchemaArnsPaginator(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client .listPublishedSchemaArnsPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.
This is a convenience which creates an instance of the
ListPublishedSchemaArnsRequest.Builder
avoiding the need to create one manually viaListPublishedSchemaArnsRequest.builder()
- Parameters:
listPublishedSchemaArnsRequest
- AConsumer
that will call methods onListPublishedSchemaArnsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException 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.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation.- Parameters:
listTagsForResourceRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResourcePaginator
default ListTagsForResourceIterable listTagsForResourcePaginator(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client .listTagsForResourcePaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation.
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypedLinkFacetAttributes
default ListTypedLinkFacetAttributesResponse listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.
- Parameters:
listTypedLinkFacetAttributesRequest
-- Returns:
- Result of the ListTypedLinkFacetAttributes operation returned by the service.
- See Also:
-
listTypedLinkFacetAttributes
default ListTypedLinkFacetAttributesResponse listTypedLinkFacetAttributes(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Returns a paginated list of all attribute definitions for a particular TypedLinkFacet. For more information, see Typed Links.
This is a convenience which creates an instance of the
ListTypedLinkFacetAttributesRequest.Builder
avoiding the need to create one manually viaListTypedLinkFacetAttributesRequest.builder()
- Parameters:
listTypedLinkFacetAttributesRequest
- AConsumer
that will call methods onListTypedLinkFacetAttributesRequest.Builder
to create a request.- Returns:
- Result of the ListTypedLinkFacetAttributes operation returned by the service.
- See Also:
-
listTypedLinkFacetAttributesPaginator
default ListTypedLinkFacetAttributesIterable listTypedLinkFacetAttributesPaginator(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client .listTypedLinkFacetAttributesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation.- Parameters:
listTypedLinkFacetAttributesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypedLinkFacetAttributesPaginator
default ListTypedLinkFacetAttributesIterable listTypedLinkFacetAttributesPaginator(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client .listTypedLinkFacetAttributesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation.
This is a convenience which creates an instance of the
ListTypedLinkFacetAttributesRequest.Builder
avoiding the need to create one manually viaListTypedLinkFacetAttributesRequest.builder()
- Parameters:
listTypedLinkFacetAttributesRequest
- AConsumer
that will call methods onListTypedLinkFacetAttributesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypedLinkFacetNames
default ListTypedLinkFacetNamesResponse listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Returns a paginated list of
TypedLink
facet names for a particular schema. For more information, see Typed Links.- Parameters:
listTypedLinkFacetNamesRequest
-- Returns:
- Result of the ListTypedLinkFacetNames operation returned by the service.
- See Also:
-
listTypedLinkFacetNames
default ListTypedLinkFacetNamesResponse listTypedLinkFacetNames(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException Returns a paginated list of
TypedLink
facet names for a particular schema. For more information, see Typed Links.
This is a convenience which creates an instance of the
ListTypedLinkFacetNamesRequest.Builder
avoiding the need to create one manually viaListTypedLinkFacetNamesRequest.builder()
- Parameters:
listTypedLinkFacetNamesRequest
- AConsumer
that will call methods onListTypedLinkFacetNamesRequest.Builder
to create a request.- Returns:
- Result of the ListTypedLinkFacetNames operation returned by the service.
- See Also:
-
listTypedLinkFacetNamesPaginator
default ListTypedLinkFacetNamesIterable listTypedLinkFacetNamesPaginator(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client .listTypedLinkFacetNamesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation.- Parameters:
listTypedLinkFacetNamesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTypedLinkFacetNamesPaginator
default ListTypedLinkFacetNamesIterable listTypedLinkFacetNamesPaginator(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client .listTypedLinkFacetNamesPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation.
This is a convenience which creates an instance of the
ListTypedLinkFacetNamesRequest.Builder
avoiding the need to create one manually viaListTypedLinkFacetNamesRequest.builder()
- Parameters:
listTypedLinkFacetNamesRequest
- AConsumer
that will call methods onListTypedLinkFacetNamesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
lookupPolicy
default LookupPolicyResponse lookupPolicy(LookupPolicyRequest lookupPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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 returnsObjectIdentifier
,policyId
, andpolicyType
. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.- Parameters:
lookupPolicyRequest
-- Returns:
- Result of the LookupPolicy operation returned by the service.
- See Also:
-
lookupPolicy
default LookupPolicyResponse lookupPolicy(Consumer<LookupPolicyRequest.Builder> lookupPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException 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 returnsObjectIdentifier
,policyId
, andpolicyType
. Paths that don't lead to the root from the target object are ignored. For more information, see Policies.
This is a convenience which creates an instance of the
LookupPolicyRequest.Builder
avoiding the need to create one manually viaLookupPolicyRequest.builder()
- Parameters:
lookupPolicyRequest
- AConsumer
that will call methods onLookupPolicyRequest.Builder
to create a request.- Returns:
- Result of the LookupPolicy operation returned by the service.
- See Also:
-
lookupPolicyPaginator
default LookupPolicyIterable lookupPolicyPaginator(LookupPolicyRequest lookupPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client .lookupPolicyPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.LookupPolicyResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation.- Parameters:
lookupPolicyRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
lookupPolicyPaginator
default LookupPolicyIterable lookupPolicyPaginator(Consumer<LookupPolicyRequest.Builder> lookupPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, InvalidNextTokenException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException This is a variant of
lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client .lookupPolicyPaginator(request); for (software.amazon.awssdk.services.clouddirectory.model.LookupPolicyResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation.
This is a convenience which creates an instance of the
LookupPolicyRequest.Builder
avoiding the need to create one manually viaLookupPolicyRequest.builder()
- Parameters:
lookupPolicyRequest
- AConsumer
that will call methods onLookupPolicyRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
publishSchema
default PublishSchemaResponse publishSchema(PublishSchemaRequest publishSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, SchemaAlreadyPublishedException, AwsServiceException, SdkClientException, CloudDirectoryException Publishes a development schema with a major version and a recommended minor version.
- Parameters:
publishSchemaRequest
-- Returns:
- Result of the PublishSchema operation returned by the service.
- See Also:
-
publishSchema
default PublishSchemaResponse publishSchema(Consumer<PublishSchemaRequest.Builder> publishSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, SchemaAlreadyPublishedException, AwsServiceException, SdkClientException, CloudDirectoryException Publishes a development schema with a major version and a recommended minor version.
This is a convenience which creates an instance of the
PublishSchemaRequest.Builder
avoiding the need to create one manually viaPublishSchemaRequest.builder()
- Parameters:
publishSchemaRequest
- AConsumer
that will call methods onPublishSchemaRequest.Builder
to create a request.- Returns:
- Result of the PublishSchema operation returned by the service.
- See Also:
-
putSchemaFromJson
default PutSchemaFromJsonResponse putSchemaFromJson(PutSchemaFromJsonRequest putSchemaFromJsonRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidSchemaDocException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
- Parameters:
putSchemaFromJsonRequest
-- Returns:
- Result of the PutSchemaFromJson operation returned by the service.
- See Also:
-
putSchemaFromJson
default PutSchemaFromJsonResponse putSchemaFromJson(Consumer<PutSchemaFromJsonRequest.Builder> putSchemaFromJsonRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidSchemaDocException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException Allows a schema to be updated using JSON upload. Only available for development schemas. See JSON Schema Format for more information.
This is a convenience which creates an instance of the
PutSchemaFromJsonRequest.Builder
avoiding the need to create one manually viaPutSchemaFromJsonRequest.builder()
- Parameters:
putSchemaFromJsonRequest
- AConsumer
that will call methods onPutSchemaFromJsonRequest.Builder
to create a request.- Returns:
- Result of the PutSchemaFromJson operation returned by the service.
- See Also:
-
removeFacetFromObject
default RemoveFacetFromObjectResponse removeFacetFromObject(RemoveFacetFromObjectRequest removeFacetFromObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Removes the specified facet from the specified object.
- Parameters:
removeFacetFromObjectRequest
-- Returns:
- Result of the RemoveFacetFromObject operation returned by the service.
- See Also:
-
removeFacetFromObject
default RemoveFacetFromObjectResponse removeFacetFromObject(Consumer<RemoveFacetFromObjectRequest.Builder> removeFacetFromObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Removes the specified facet from the specified object.
This is a convenience which creates an instance of the
RemoveFacetFromObjectRequest.Builder
avoiding the need to create one manually viaRemoveFacetFromObjectRequest.builder()
- Parameters:
removeFacetFromObjectRequest
- AConsumer
that will call methods onRemoveFacetFromObjectRequest.Builder
to create a request.- Returns:
- Result of the RemoveFacetFromObject operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException An API operation for adding tags to a resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException An API operation for adding tags to a resource.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException An API operation for removing tags from a resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidTaggingRequestException, AwsServiceException, SdkClientException, CloudDirectoryException An API operation for removing tags from a resource.
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateFacet
default UpdateFacetResponse updateFacet(UpdateFacetRequest updateFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidFacetUpdateException, FacetValidationException, ResourceNotFoundException, FacetNotFoundException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException Does the following:
-
Adds new
Attributes
,Rules
, orObjectTypes
. -
Updates existing
Attributes
,Rules
, orObjectTypes
. -
Deletes existing
Attributes
,Rules
, orObjectTypes
.
- Parameters:
updateFacetRequest
-- Returns:
- Result of the UpdateFacet operation returned by the service.
- See Also:
-
-
updateFacet
default UpdateFacetResponse updateFacet(Consumer<UpdateFacetRequest.Builder> updateFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidFacetUpdateException, FacetValidationException, ResourceNotFoundException, FacetNotFoundException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException Does the following:
-
Adds new
Attributes
,Rules
, orObjectTypes
. -
Updates existing
Attributes
,Rules
, orObjectTypes
. -
Deletes existing
Attributes
,Rules
, orObjectTypes
.
This is a convenience which creates an instance of the
UpdateFacetRequest.Builder
avoiding the need to create one manually viaUpdateFacetRequest.builder()
- Parameters:
updateFacetRequest
- AConsumer
that will call methods onUpdateFacetRequest.Builder
to create a request.- Returns:
- Result of the UpdateFacet operation returned by the service.
- See Also:
-
-
updateLinkAttributes
default UpdateLinkAttributesResponse updateLinkAttributes(UpdateLinkAttributesRequest updateLinkAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException 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
.- Parameters:
updateLinkAttributesRequest
-- Returns:
- Result of the UpdateLinkAttributes operation returned by the service.
- See Also:
-
updateLinkAttributes
default UpdateLinkAttributesResponse updateLinkAttributes(Consumer<UpdateLinkAttributesRequest.Builder> updateLinkAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException 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
.
This is a convenience which creates an instance of the
UpdateLinkAttributesRequest.Builder
avoiding the need to create one manually viaUpdateLinkAttributesRequest.builder()
- Parameters:
updateLinkAttributesRequest
- AConsumer
that will call methods onUpdateLinkAttributesRequest.Builder
to create a request.- Returns:
- Result of the UpdateLinkAttributes operation returned by the service.
- See Also:
-
updateObjectAttributes
default UpdateObjectAttributesResponse updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, LinkNameAlreadyInUseException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Updates a given object's attributes.
- Parameters:
updateObjectAttributesRequest
-- Returns:
- Result of the UpdateObjectAttributes operation returned by the service.
- See Also:
-
updateObjectAttributes
default UpdateObjectAttributesResponse updateObjectAttributes(Consumer<UpdateObjectAttributesRequest.Builder> updateObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, LinkNameAlreadyInUseException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException Updates a given object's attributes.
This is a convenience which creates an instance of the
UpdateObjectAttributesRequest.Builder
avoiding the need to create one manually viaUpdateObjectAttributesRequest.builder()
- Parameters:
updateObjectAttributesRequest
- AConsumer
that will call methods onUpdateObjectAttributesRequest.Builder
to create a request.- Returns:
- Result of the UpdateObjectAttributes operation returned by the service.
- See Also:
-
updateSchema
default UpdateSchemaResponse updateSchema(UpdateSchemaRequest updateSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Updates the schema name with a new name. Only development schema names can be updated.
- Parameters:
updateSchemaRequest
-- Returns:
- Result of the UpdateSchema operation returned by the service.
- See Also:
-
updateSchema
default UpdateSchemaResponse updateSchema(Consumer<UpdateSchemaRequest.Builder> updateSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException Updates the schema name with a new name. Only development schema names can be updated.
This is a convenience which creates an instance of the
UpdateSchemaRequest.Builder
avoiding the need to create one manually viaUpdateSchemaRequest.builder()
- Parameters:
updateSchemaRequest
- AConsumer
that will call methods onUpdateSchemaRequest.Builder
to create a request.- Returns:
- Result of the UpdateSchema operation returned by the service.
- See Also:
-
updateTypedLinkFacet
default UpdateTypedLinkFacetResponse updateTypedLinkFacet(UpdateTypedLinkFacetRequest updateTypedLinkFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, FacetValidationException, InvalidFacetUpdateException, ResourceNotFoundException, FacetNotFoundException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException Updates a TypedLinkFacet. For more information, see Typed Links.
- Parameters:
updateTypedLinkFacetRequest
-- Returns:
- Result of the UpdateTypedLinkFacet operation returned by the service.
- See Also:
-
updateTypedLinkFacet
default UpdateTypedLinkFacetResponse updateTypedLinkFacet(Consumer<UpdateTypedLinkFacetRequest.Builder> updateTypedLinkFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, FacetValidationException, InvalidFacetUpdateException, ResourceNotFoundException, FacetNotFoundException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException Updates a TypedLinkFacet. For more information, see Typed Links.
This is a convenience which creates an instance of the
UpdateTypedLinkFacetRequest.Builder
avoiding the need to create one manually viaUpdateTypedLinkFacetRequest.builder()
- Parameters:
updateTypedLinkFacetRequest
- AConsumer
that will call methods onUpdateTypedLinkFacetRequest.Builder
to create a request.- Returns:
- Result of the UpdateTypedLinkFacet operation returned by the service.
- See Also:
-
upgradeAppliedSchema
default UpgradeAppliedSchemaResponse upgradeAppliedSchema(UpgradeAppliedSchemaRequest upgradeAppliedSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, IncompatibleSchemaException, AccessDeniedException, ResourceNotFoundException, InvalidAttachmentException, SchemaAlreadyExistsException, AwsServiceException, SdkClientException, CloudDirectoryException Upgrades a single directory in-place using the
PublishedSchemaArn
with schema updates found inMinorVersion
. 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.- Parameters:
upgradeAppliedSchemaRequest
-- Returns:
- Result of the UpgradeAppliedSchema operation returned by the service.
- See Also:
-
upgradeAppliedSchema
default UpgradeAppliedSchemaResponse upgradeAppliedSchema(Consumer<UpgradeAppliedSchemaRequest.Builder> upgradeAppliedSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, IncompatibleSchemaException, AccessDeniedException, ResourceNotFoundException, InvalidAttachmentException, SchemaAlreadyExistsException, AwsServiceException, SdkClientException, CloudDirectoryException Upgrades a single directory in-place using the
PublishedSchemaArn
with schema updates found inMinorVersion
. 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.
This is a convenience which creates an instance of the
UpgradeAppliedSchemaRequest.Builder
avoiding the need to create one manually viaUpgradeAppliedSchemaRequest.builder()
- Parameters:
upgradeAppliedSchemaRequest
- AConsumer
that will call methods onUpgradeAppliedSchemaRequest.Builder
to create a request.- Returns:
- Result of the UpgradeAppliedSchema operation returned by the service.
- See Also:
-
upgradePublishedSchema
default UpgradePublishedSchemaResponse upgradePublishedSchema(UpgradePublishedSchemaRequest upgradePublishedSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, IncompatibleSchemaException, AccessDeniedException, ResourceNotFoundException, InvalidAttachmentException, LimitExceededException, AwsServiceException, SdkClientException, CloudDirectoryException Upgrades a published schema under a new minor version revision using the current contents of
DevelopmentSchemaArn
.- Parameters:
upgradePublishedSchemaRequest
-- Returns:
- Result of the UpgradePublishedSchema operation returned by the service.
- See Also:
-
upgradePublishedSchema
default UpgradePublishedSchemaResponse upgradePublishedSchema(Consumer<UpgradePublishedSchemaRequest.Builder> upgradePublishedSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, IncompatibleSchemaException, AccessDeniedException, ResourceNotFoundException, InvalidAttachmentException, LimitExceededException, AwsServiceException, SdkClientException, CloudDirectoryException Upgrades a published schema under a new minor version revision using the current contents of
DevelopmentSchemaArn
.
This is a convenience which creates an instance of the
UpgradePublishedSchemaRequest.Builder
avoiding the need to create one manually viaUpgradePublishedSchemaRequest.builder()
- Parameters:
upgradePublishedSchemaRequest
- AConsumer
that will call methods onUpgradePublishedSchemaRequest.Builder
to create a request.- Returns:
- Result of the UpgradePublishedSchema operation returned by the service.
- See Also:
-
create
Create aCloudDirectoryClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aCloudDirectoryClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-