@Generated(value="software.amazon.awssdk:codegen") public interface CloudDirectoryClient extends 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 AWS Directory Services features, see AWS Directory Service and the AWS Directory Service Administration Guide.
Modifier and Type | Field and Description |
---|---|
static String |
SERVICE_NAME |
Modifier and Type | Method and Description |
---|---|
default AddFacetToObjectResponse |
addFacetToObject(AddFacetToObjectRequest addFacetToObjectRequest)
Adds a new Facet to an object.
|
default AddFacetToObjectResponse |
addFacetToObject(Consumer<AddFacetToObjectRequest.Builder> addFacetToObjectRequest)
Adds a new Facet to an object.
|
default ApplySchemaResponse |
applySchema(ApplySchemaRequest applySchemaRequest)
Copies the input published schema into the Directory with the same name and version as that of the
published schema .
|
default ApplySchemaResponse |
applySchema(Consumer<ApplySchemaRequest.Builder> applySchemaRequest)
Copies the input published schema into the Directory with the same name and version as that of the
published schema .
|
default AttachObjectResponse |
attachObject(AttachObjectRequest attachObjectRequest)
Attaches an existing object to another object.
|
default AttachObjectResponse |
attachObject(Consumer<AttachObjectRequest.Builder> attachObjectRequest)
Attaches an existing object to another object.
|
default AttachPolicyResponse |
attachPolicy(AttachPolicyRequest attachPolicyRequest)
Attaches a policy object to a regular object.
|
default AttachPolicyResponse |
attachPolicy(Consumer<AttachPolicyRequest.Builder> attachPolicyRequest)
Attaches a policy object to a regular object.
|
default AttachToIndexResponse |
attachToIndex(AttachToIndexRequest attachToIndexRequest)
Attaches the specified object to the specified index.
|
default AttachToIndexResponse |
attachToIndex(Consumer<AttachToIndexRequest.Builder> attachToIndexRequest)
Attaches the specified object to the specified index.
|
default AttachTypedLinkResponse |
attachTypedLink(AttachTypedLinkRequest attachTypedLinkRequest)
Attaches a typed link to a specified source and target object.
|
default AttachTypedLinkResponse |
attachTypedLink(Consumer<AttachTypedLinkRequest.Builder> attachTypedLinkRequest)
Attaches a typed link to a specified source and target object.
|
default BatchReadResponse |
batchRead(BatchReadRequest batchReadRequest)
Performs all the read operations in a batch.
|
default BatchReadResponse |
batchRead(Consumer<BatchReadRequest.Builder> batchReadRequest)
Performs all the read operations in a batch.
|
default BatchWriteResponse |
batchWrite(BatchWriteRequest batchWriteRequest)
Performs all the write operations in a batch.
|
default BatchWriteResponse |
batchWrite(Consumer<BatchWriteRequest.Builder> batchWriteRequest)
Performs all the write operations in a batch.
|
static CloudDirectoryClientBuilder |
builder()
Create a builder that can be used to configure and create a
CloudDirectoryClient . |
static CloudDirectoryClient |
create()
Create a
CloudDirectoryClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider . |
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 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 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.
|
default GetTypedLinkFacetInformationResponse |
getTypedLinkFacetInformation(Consumer<GetTypedLinkFacetInformationRequest.Builder> getTypedLinkFacetInformationRequest)
Returns the identity attribute order for a specific TypedLinkFacet.
|
default GetTypedLinkFacetInformationResponse |
getTypedLinkFacetInformation(GetTypedLinkFacetInformationRequest getTypedLinkFacetInformationRequest)
Returns the identity attribute order for a specific TypedLinkFacet.
|
default ListAppliedSchemaArnsResponse |
listAppliedSchemaArns(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
|
default ListAppliedSchemaArnsResponse |
listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
|
default ListAppliedSchemaArnsIterable |
listAppliedSchemaArnsPaginator(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
|
default ListAppliedSchemaArnsIterable |
listAppliedSchemaArnsPaginator(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest)
Lists schemas applied to a directory.
|
default ListAttachedIndicesResponse |
listAttachedIndices(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest)
Lists indices attached to an object.
|
default ListAttachedIndicesResponse |
listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest)
Lists indices attached to an object.
|
default ListAttachedIndicesIterable |
listAttachedIndicesPaginator(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest)
Lists indices attached to an object.
|
default ListAttachedIndicesIterable |
listAttachedIndicesPaginator(ListAttachedIndicesRequest listAttachedIndicesRequest)
Lists indices attached to an object.
|
default ListDevelopmentSchemaArnsResponse |
listDevelopmentSchemaArns()
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
default ListDevelopmentSchemaArnsResponse |
listDevelopmentSchemaArns(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
default ListDevelopmentSchemaArnsResponse |
listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
default ListDevelopmentSchemaArnsIterable |
listDevelopmentSchemaArnsPaginator()
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
default ListDevelopmentSchemaArnsIterable |
listDevelopmentSchemaArnsPaginator(Consumer<ListDevelopmentSchemaArnsRequest.Builder> listDevelopmentSchemaArnsRequest)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
default ListDevelopmentSchemaArnsIterable |
listDevelopmentSchemaArnsPaginator(ListDevelopmentSchemaArnsRequest listDevelopmentSchemaArnsRequest)
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
|
default ListDirectoriesResponse |
listDirectories()
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 |
listDirectoriesPaginator()
Lists directories created within an account.
|
default ListDirectoriesIterable |
listDirectoriesPaginator(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest)
Lists directories created within an account.
|
default ListDirectoriesIterable |
listDirectoriesPaginator(ListDirectoriesRequest listDirectoriesRequest)
Lists directories created within an account.
|
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)
Retrieves attributes attached to the facet.
|
default ListFacetAttributesIterable |
listFacetAttributesPaginator(ListFacetAttributesRequest listFacetAttributesRequest)
Retrieves attributes attached to the facet.
|
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)
Retrieves the names of facets that exist in a schema.
|
default ListFacetNamesIterable |
listFacetNamesPaginator(ListFacetNamesRequest listFacetNamesRequest)
Retrieves the names of facets that exist in a schema.
|
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)
Lists objects attached to the specified index.
|
default ListIndexIterable |
listIndexPaginator(ListIndexRequest listIndexRequest)
Lists objects attached to the specified index.
|
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)
Lists all attributes that are associated with an object.
|
default ListObjectAttributesIterable |
listObjectAttributesPaginator(ListObjectAttributesRequest listObjectAttributesRequest)
Lists all attributes that are associated with an object.
|
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)
Returns a paginated list of child objects that are associated with a given object.
|
default ListObjectChildrenIterable |
listObjectChildrenPaginator(ListObjectChildrenRequest listObjectChildrenRequest)
Returns a paginated list of child objects that are associated with a given object.
|
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)
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node
objects.
|
default ListObjectParentPathsIterable |
listObjectParentPathsPaginator(ListObjectParentPathsRequest listObjectParentPathsRequest)
Retrieves all available parent paths for any object type such as node, leaf node, policy node, and index node
objects.
|
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)
Lists parent objects that are associated with a given object in pagination fashion.
|
default ListObjectParentsIterable |
listObjectParentsPaginator(ListObjectParentsRequest listObjectParentsRequest)
Lists parent objects that are associated with a given object in pagination fashion.
|
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)
Returns policies attached to an object in pagination fashion.
|
default ListObjectPoliciesIterable |
listObjectPoliciesPaginator(ListObjectPoliciesRequest listObjectPoliciesRequest)
Returns policies attached to an object in pagination fashion.
|
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 the
ObjectIdentifiers to which a given policy is attached. |
default ListPolicyAttachmentsResponse |
listPolicyAttachments(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
Returns all of the
ObjectIdentifiers to which a given policy is attached. |
default ListPolicyAttachmentsIterable |
listPolicyAttachmentsPaginator(Consumer<ListPolicyAttachmentsRequest.Builder> listPolicyAttachmentsRequest)
Returns all of the
ObjectIdentifiers to which a given policy is attached. |
default ListPolicyAttachmentsIterable |
listPolicyAttachmentsPaginator(ListPolicyAttachmentsRequest listPolicyAttachmentsRequest)
Returns all of the
ObjectIdentifiers to which a given policy is attached. |
default ListPublishedSchemaArnsResponse |
listPublishedSchemaArns()
Retrieves each published schema Amazon Resource Name (ARN).
|
default ListPublishedSchemaArnsResponse |
listPublishedSchemaArns(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest)
Retrieves each published schema Amazon Resource Name (ARN).
|
default ListPublishedSchemaArnsResponse |
listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
Retrieves each published schema Amazon Resource Name (ARN).
|
default ListPublishedSchemaArnsIterable |
listPublishedSchemaArnsPaginator()
Retrieves each published schema Amazon Resource Name (ARN).
|
default ListPublishedSchemaArnsIterable |
listPublishedSchemaArnsPaginator(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest)
Retrieves each published schema Amazon Resource Name (ARN).
|
default ListPublishedSchemaArnsIterable |
listPublishedSchemaArnsPaginator(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest)
Retrieves each published schema Amazon Resource Name (ARN).
|
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)
Returns tags for a resource.
|
default ListTagsForResourceIterable |
listTagsForResourcePaginator(ListTagsForResourceRequest listTagsForResourceRequest)
Returns tags for a resource.
|
default ListTypedLinkFacetAttributesResponse |
listTypedLinkFacetAttributes(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
|
default ListTypedLinkFacetAttributesResponse |
listTypedLinkFacetAttributes(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
|
default ListTypedLinkFacetAttributesIterable |
listTypedLinkFacetAttributesPaginator(Consumer<ListTypedLinkFacetAttributesRequest.Builder> listTypedLinkFacetAttributesRequest)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
|
default ListTypedLinkFacetAttributesIterable |
listTypedLinkFacetAttributesPaginator(ListTypedLinkFacetAttributesRequest listTypedLinkFacetAttributesRequest)
Returns a paginated list of all attribute definitions for a particular TypedLinkFacet.
|
default ListTypedLinkFacetNamesResponse |
listTypedLinkFacetNames(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest)
Returns a paginated list of
TypedLink facet names for a particular schema. |
default ListTypedLinkFacetNamesResponse |
listTypedLinkFacetNames(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)
Returns a paginated list of
TypedLink facet names for a particular schema. |
default ListTypedLinkFacetNamesIterable |
listTypedLinkFacetNamesPaginator(Consumer<ListTypedLinkFacetNamesRequest.Builder> listTypedLinkFacetNamesRequest)
Returns a paginated list of
TypedLink facet names for a particular schema. |
default ListTypedLinkFacetNamesIterable |
listTypedLinkFacetNamesPaginator(ListTypedLinkFacetNamesRequest listTypedLinkFacetNamesRequest)
Returns a paginated list of
TypedLink facet names for a particular schema. |
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)
Lists all policies from the root of the Directory to the object specified.
|
default LookupPolicyIterable |
lookupPolicyPaginator(LookupPolicyRequest lookupPolicyRequest)
Lists all policies from the root of the Directory to the object specified.
|
default PublishSchemaResponse |
publishSchema(Consumer<PublishSchemaRequest.Builder> publishSchemaRequest)
Publishes a development schema with a version.
|
default PublishSchemaResponse |
publishSchema(PublishSchemaRequest publishSchemaRequest)
Publishes a development schema with a 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.
|
static ServiceMetadata |
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 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.
|
serviceName
close
static final String SERVICE_NAME
static CloudDirectoryClient create()
CloudDirectoryClient
with the region loaded from the
DefaultAwsRegionProviderChain
and credentials loaded from the
DefaultCredentialsProvider
.static CloudDirectoryClientBuilder builder()
CloudDirectoryClient
.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.
addFacetToObjectRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
This is a convenience which creates an instance of the AddFacetToObjectRequest.Builder
avoiding the need
to create one manually via AddFacetToObjectRequest.builder()
addFacetToObjectRequest
- A Consumer
that will call methods on AddFacetToObjectRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ApplySchemaResponse applySchema(ApplySchemaRequest applySchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidAttachmentException, AwsServiceException, SdkClientException, CloudDirectoryException
Copies the input published schema into the Directory with the same name and version as that of the published schema .
applySchemaRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ApplySchemaResponse applySchema(Consumer<ApplySchemaRequest.Builder> applySchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidAttachmentException, AwsServiceException, SdkClientException, CloudDirectoryException
Copies the input published schema 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 via ApplySchemaRequest.builder()
applySchemaRequest
- A Consumer
that will call methods on ApplySchemaRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
attachObjectRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.InvalidAttachmentException
- Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AttachObjectRequest.builder()
attachObjectRequest
- A Consumer
that will call methods on AttachObjectRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.InvalidAttachmentException
- Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
attachPolicyRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via AttachPolicyRequest.builder()
attachPolicyRequest
- A Consumer
that will call methods on AttachPolicyRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachToIndexResponse attachToIndex(AttachToIndexRequest attachToIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, LinkNameAlreadyInUseException, IndexedAttributeMissingException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException
Attaches the specified object to the specified index.
attachToIndexRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.IndexedAttributeMissingException
- An object has been attempted to be attached to an object that does not have the appropriate attribute
value.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default AttachToIndexResponse attachToIndex(Consumer<AttachToIndexRequest.Builder> attachToIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, 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 via AttachToIndexRequest.builder()
attachToIndexRequest
- A Consumer
that will call methods on AttachToIndexRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.IndexedAttributeMissingException
- An object has been attempted to be attached to an object that does not have the appropriate attribute
value.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
attachTypedLinkRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the AttachTypedLinkRequest.Builder
avoiding the need
to create one manually via AttachTypedLinkRequest.builder()
attachTypedLinkRequest
- A Consumer
that will call methods on AttachTypedLinkRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidAttachmentException
- Indicates that an attempt to attach an object with the same link name or to apply a schema with the same
name has occurred. Rename the link or the schema and then try again.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default BatchReadResponse batchRead(BatchReadRequest batchReadRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, AwsServiceException, SdkClientException, CloudDirectoryException
Performs all the read operations in a batch.
batchReadRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via BatchReadRequest.builder()
batchReadRequest
- A Consumer
that will call methods on BatchReadRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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. Batch writes supports only object-related operations.
batchWriteRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.BatchWriteException
- A BatchWrite
exception has occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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. Batch writes supports only object-related operations.
This is a convenience which creates an instance of the BatchWriteRequest.Builder
avoiding the need to
create one manually via BatchWriteRequest.builder()
batchWriteRequest
- A Consumer
that will call methods on BatchWriteRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.BatchWriteException
- A BatchWrite
exception has occurred.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createDirectoryRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryAlreadyExistsException
- Indicates that a Directory could not be created due to a naming conflict. Choose a different name
and try again.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
This is a convenience which creates an instance of the CreateDirectoryRequest.Builder
avoiding the need
to create one manually via CreateDirectoryRequest.builder()
createDirectoryRequest
- A Consumer
that will call methods on CreateDirectoryRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryAlreadyExistsException
- Indicates that a Directory could not be created due to a naming conflict. Choose a different name
and try again.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetAlreadyExistsException
- A facet with the same name already exists.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateFacetRequest.builder()
createFacetRequest
- A Consumer
that will call methods on CreateFacetRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetAlreadyExistsException
- A facet with the same name already exists.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 for more information.
createIndexRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.UnsupportedIndexTypeException
- Indicates that the requested index type is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 for more information.
This is a convenience which creates an instance of the CreateIndexRequest.Builder
avoiding the need to
create one manually via CreateIndexRequest.builder()
createIndexRequest
- A Consumer
that will call methods on CreateIndexRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.UnsupportedIndexTypeException
- Indicates that the requested index type is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createObjectRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.UnsupportedIndexTypeException
- Indicates that the requested index type is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateObjectRequest.builder()
createObjectRequest
- A Consumer
that will call methods on CreateObjectRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.LinkNameAlreadyInUseException
- Indicates that a link could not be created due to a naming conflict. Choose a different name and then try
again.UnsupportedIndexTypeException
- Indicates that the requested index type is not supported.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
createSchemaRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.SchemaAlreadyExistsException
- Indicates that a schema could not be created due to a naming conflict. Please select a different name and
then try again.AccessDeniedException
- Access denied. Check your permissions.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via CreateSchemaRequest.builder()
createSchemaRequest
- A Consumer
that will call methods on CreateSchemaRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.SchemaAlreadyExistsException
- Indicates that a schema could not be created due to a naming conflict. Please select a different name and
then try again.AccessDeniedException
- Access denied. Check your permissions.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
createTypedLinkFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetAlreadyExistsException
- A facet with the same name already exists.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the CreateTypedLinkFacetRequest.Builder
avoiding the
need to create one manually via CreateTypedLinkFacetRequest.builder()
createTypedLinkFacetRequest
- A Consumer
that will call methods on CreateTypedLinkFacetRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetAlreadyExistsException
- A facet with the same name already exists.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteDirectoryRequest
- ResourceNotFoundException
- The specified resource could not be found.DirectoryNotDisabledException
- An operation can only operate on a disabled directory.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryDeletedException
- A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException
- Indicates that the provided ARN value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteDirectoryRequest.builder()
deleteDirectoryRequest
- A Consumer
that will call methods on DeleteDirectoryRequest.Builder
to create a request.ResourceNotFoundException
- The specified resource could not be found.DirectoryNotDisabledException
- An operation can only operate on a disabled directory.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryDeletedException
- A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException
- Indicates that the provided ARN value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.FacetInUseException
- Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a
different facet.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteFacetRequest.builder()
deleteFacetRequest
- A Consumer
that will call methods on DeleteFacetRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.FacetInUseException
- Occurs when deleting a facet that contains an attribute that is a target to an attribute reference in a
different facet.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteObjectRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.ObjectNotDetachedException
- Indicates that the requested operation cannot be completed because the object has not been detached from
the tree.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
This is a convenience which creates an instance of the DeleteObjectRequest.Builder
avoiding the need to
create one manually via DeleteObjectRequest.builder()
deleteObjectRequest
- A Consumer
that will call methods on DeleteObjectRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.ObjectNotDetachedException
- Indicates that the requested operation cannot be completed because the object has not been detached from
the tree.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
deleteSchemaRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.StillContainsLinksException
- The object could not be deleted because links still exist. Remove the links and then try the operation
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DeleteSchemaRequest.builder()
deleteSchemaRequest
- A Consumer
that will call methods on DeleteSchemaRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.StillContainsLinksException
- The object could not be deleted because links still exist. Remove the links and then try the operation
again.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
deleteTypedLinkFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the DeleteTypedLinkFacetRequest.Builder
avoiding the
need to create one manually via DeleteTypedLinkFacetRequest.builder()
deleteTypedLinkFacetRequest
- A Consumer
that will call methods on DeleteTypedLinkFacetRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
detachFromIndexRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.ObjectAlreadyDetachedException
- Indicates that the object is not attached to the index.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DetachFromIndexRequest.builder()
detachFromIndexRequest
- A Consumer
that will call methods on DetachFromIndexRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.ObjectAlreadyDetachedException
- Indicates that the object is not attached to the index.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachObjectResponse detachObject(DetachObjectRequest detachObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, 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.
detachObjectRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachObjectResponse detachObject(Consumer<DetachObjectRequest.Builder> detachObjectRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, 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 via DetachObjectRequest.builder()
detachObjectRequest
- A Consumer
that will call methods on DetachObjectRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default DetachPolicyResponse detachPolicy(DetachPolicyRequest detachPolicyRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotPolicyException, AwsServiceException, SdkClientException, CloudDirectoryException
Detaches a policy from an object.
detachPolicyRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DetachPolicyRequest.builder()
detachPolicyRequest
- A Consumer
that will call methods on DetachPolicyRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
detachTypedLinkRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the DetachTypedLinkRequest.Builder
avoiding the need
to create one manually via DetachTypedLinkRequest.builder()
detachTypedLinkRequest
- A Consumer
that will call methods on DetachTypedLinkRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
disableDirectoryRequest
- ResourceNotFoundException
- The specified resource could not be found.DirectoryDeletedException
- A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException
- Indicates that the provided ARN value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via DisableDirectoryRequest.builder()
disableDirectoryRequest
- A Consumer
that will call methods on DisableDirectoryRequest.Builder
to create a request.ResourceNotFoundException
- The specified resource could not be found.DirectoryDeletedException
- A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException
- Indicates that the provided ARN value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
enableDirectoryRequest
- ResourceNotFoundException
- The specified resource could not be found.DirectoryDeletedException
- A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException
- Indicates that the provided ARN value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via EnableDirectoryRequest.builder()
enableDirectoryRequest
- A Consumer
that will call methods on EnableDirectoryRequest.Builder
to create a request.ResourceNotFoundException
- The specified resource could not be found.DirectoryDeletedException
- A directory that has been deleted and to which access has been attempted. Note: The requested resource
will eventually cease to exist.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.InvalidArnException
- Indicates that the provided ARN value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetDirectoryResponse getDirectory(GetDirectoryRequest getDirectoryRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves metadata about a directory.
getDirectoryRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetDirectoryRequest.builder()
getDirectoryRequest
- A Consumer
that will call methods on GetDirectoryRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetFacetRequest.builder()
getFacetRequest
- A Consumer
that will call methods on GetFacetRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default GetObjectInformationResponse getObjectInformation(GetObjectInformationRequest getObjectInformationRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves metadata about an object.
getObjectInformationRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetObjectInformationRequest.builder()
getObjectInformationRequest
- A Consumer
that will call methods on GetObjectInformationRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
getSchemaAsJsonRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via GetSchemaAsJsonRequest.builder()
getSchemaAsJsonRequest
- A Consumer
that will call methods on GetSchemaAsJsonRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
getTypedLinkFacetInformationRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetNotFoundException
- The specified Facet could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the GetTypedLinkFacetInformationRequest.Builder
avoiding the need to create one manually via GetTypedLinkFacetInformationRequest.builder()
getTypedLinkFacetInformationRequest
- A Consumer
that will call methods on GetTypedLinkFacetInformationRequest.Builder
to create
a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetNotFoundException
- The specified Facet could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAppliedSchemaArnsResponse listAppliedSchemaArns(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists schemas applied to a directory.
listAppliedSchemaArnsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAppliedSchemaArnsResponse listAppliedSchemaArns(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists schemas applied to a directory.
This is a convenience which creates an instance of the ListAppliedSchemaArnsRequest.Builder
avoiding the
need to create one manually via ListAppliedSchemaArnsRequest.builder()
listAppliedSchemaArnsRequest
- A Consumer
that will call methods on ListAppliedSchemaArnsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAppliedSchemaArnsIterable listAppliedSchemaArnsPaginator(ListAppliedSchemaArnsRequest listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists schemas applied to a directory.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAppliedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListAppliedSchemaArnsRequest)
operation.
listAppliedSchemaArnsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAppliedSchemaArnsIterable listAppliedSchemaArnsPaginator(Consumer<ListAppliedSchemaArnsRequest.Builder> listAppliedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists schemas applied to a directory.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListAppliedSchemaArnsIterable responses = client.listAppliedSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListAppliedSchemaArnsRequest.builder()
listAppliedSchemaArnsRequest
- A Consumer
that will call methods on ListAppliedSchemaArnsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedIndicesResponse listAttachedIndices(ListAttachedIndicesRequest listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists indices attached to an object.
listAttachedIndicesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedIndicesResponse listAttachedIndices(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists indices attached to an object.
This is a convenience which creates an instance of the ListAttachedIndicesRequest.Builder
avoiding the
need to create one manually via ListAttachedIndicesRequest.builder()
listAttachedIndicesRequest
- A Consumer
that will call methods on ListAttachedIndicesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedIndicesIterable listAttachedIndicesPaginator(ListAttachedIndicesRequest listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists indices attached to an object.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listAttachedIndices(software.amazon.awssdk.services.clouddirectory.model.ListAttachedIndicesRequest)
operation.
listAttachedIndicesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListAttachedIndicesIterable listAttachedIndicesPaginator(Consumer<ListAttachedIndicesRequest.Builder> listAttachedIndicesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists indices attached to an object.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListAttachedIndicesIterable responses = client.listAttachedIndicesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListAttachedIndicesRequest.builder()
listAttachedIndicesRequest
- A Consumer
that will call methods on ListAttachedIndicesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDevelopmentSchemaArnsResponse listDevelopmentSchemaArns() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each Amazon Resource Name (ARN) of schemas in the development state.
InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDevelopmentSchemaArns(ListDevelopmentSchemaArnsRequest)
,
AWS API Documentationdefault 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.
listDevelopmentSchemaArnsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListDevelopmentSchemaArnsRequest.builder()
listDevelopmentSchemaArnsRequest
- A Consumer
that will call methods on ListDevelopmentSchemaArnsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDevelopmentSchemaArnsIterable listDevelopmentSchemaArnsPaginator() 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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.
InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDevelopmentSchemaArnsPaginator(ListDevelopmentSchemaArnsRequest)
,
AWS API Documentationdefault ListDevelopmentSchemaArnsIterable listDevelopmentSchemaArnsPaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDevelopmentSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListDevelopmentSchemaArnsRequest)
operation.
listDevelopmentSchemaArnsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDevelopmentSchemaArnsIterable listDevelopmentSchemaArnsPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListDevelopmentSchemaArnsIterable responses = client.listDevelopmentSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListDevelopmentSchemaArnsRequest.builder()
listDevelopmentSchemaArnsRequest
- A Consumer
that will call methods on ListDevelopmentSchemaArnsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDirectoriesResponse listDirectories() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists directories created within an account.
InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDirectories(ListDirectoriesRequest)
,
AWS
API Documentationdefault ListDirectoriesResponse listDirectories(ListDirectoriesRequest listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists directories created within an account.
listDirectoriesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListDirectoriesRequest.builder()
listDirectoriesRequest
- A Consumer
that will call methods on ListDirectoriesRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDirectoriesIterable listDirectoriesPaginator() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists directories created within an account.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.
InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listDirectoriesPaginator(ListDirectoriesRequest)
,
AWS
API Documentationdefault ListDirectoriesIterable listDirectoriesPaginator(ListDirectoriesRequest listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists directories created within an account.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listDirectories(software.amazon.awssdk.services.clouddirectory.model.ListDirectoriesRequest)
operation.
listDirectoriesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListDirectoriesIterable listDirectoriesPaginator(Consumer<ListDirectoriesRequest.Builder> listDirectoriesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists directories created within an account.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListDirectoriesIterable responses = client.listDirectoriesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListDirectoriesRequest.builder()
listDirectoriesRequest
- A Consumer
that will call methods on ListDirectoriesRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacetAttributesResponse listFacetAttributes(ListFacetAttributesRequest listFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves attributes attached to the facet.
listFacetAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListFacetAttributesRequest.builder()
listFacetAttributesRequest
- A Consumer
that will call methods on ListFacetAttributesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacetAttributesIterable listFacetAttributesPaginator(ListFacetAttributesRequest listFacetAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, FacetNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves attributes attached to the facet.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListFacetAttributesRequest)
operation.
listFacetAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacetAttributesIterable listFacetAttributesPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetAttributesIterable responses = client.listFacetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListFacetAttributesRequest.builder()
listFacetAttributesRequest
- A Consumer
that will call methods on ListFacetAttributesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listFacetNamesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListFacetNamesRequest.builder()
listFacetNamesRequest
- A Consumer
that will call methods on ListFacetNamesRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacetNamesIterable listFacetNamesPaginator(ListFacetNamesRequest 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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListFacetNamesRequest)
operation.
listFacetNamesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListFacetNamesIterable listFacetNamesPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListFacetNamesIterable responses = client.listFacetNamesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListFacetNamesRequest.builder()
listFacetNamesRequest
- A Consumer
that will call methods on ListFacetNamesRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
listIncomingTypedLinksRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the ListIncomingTypedLinksRequest.Builder
avoiding the
need to create one manually via ListIncomingTypedLinksRequest.builder()
listIncomingTypedLinksRequest
- A Consumer
that will call methods on ListIncomingTypedLinksRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIndexResponse listIndex(ListIndexRequest listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists objects attached to the specified index.
listIndexRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIndexResponse listIndex(Consumer<ListIndexRequest.Builder> listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, 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 via ListIndexRequest.builder()
listIndexRequest
- A Consumer
that will call methods on ListIndexRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIndexIterable listIndexPaginator(ListIndexRequest listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists objects attached to the specified index.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listIndex(software.amazon.awssdk.services.clouddirectory.model.ListIndexRequest)
operation.
listIndexRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListIndexIterable listIndexPaginator(Consumer<ListIndexRequest.Builder> listIndexRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, NotIndexException, AwsServiceException, SdkClientException, CloudDirectoryException
Lists objects attached to the specified index.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListIndexIterable responses = client.listIndexPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListIndexRequest.builder()
listIndexRequest
- A Consumer
that will call methods on ListIndexRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.NotIndexException
- Indicates that the requested operation can only operate on index objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listObjectAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListObjectAttributesRequest.builder()
listObjectAttributesRequest
- A Consumer
that will call methods on ListObjectAttributesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectAttributesIterable listObjectAttributesPaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listObjectAttributes(software.amazon.awssdk.services.clouddirectory.model.ListObjectAttributesRequest)
operation.
listObjectAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectAttributesIterable listObjectAttributesPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectAttributesIterable responses = client.listObjectAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListObjectAttributesRequest.builder()
listObjectAttributesRequest
- A Consumer
that will call methods on ListObjectAttributesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listObjectChildrenRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.NotNodeException
- Occurs when any invalid operations are performed on an object that is not a node, such as calling
ListObjectChildren
for a leaf node object.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListObjectChildrenRequest.builder()
listObjectChildrenRequest
- A Consumer
that will call methods on ListObjectChildrenRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.NotNodeException
- Occurs when any invalid operations are performed on an object that is not a node, such as calling
ListObjectChildren
for a leaf node object.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectChildrenIterable listObjectChildrenPaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listObjectChildren(software.amazon.awssdk.services.clouddirectory.model.ListObjectChildrenRequest)
operation.
listObjectChildrenRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.NotNodeException
- Occurs when any invalid operations are performed on an object that is not a node, such as calling
ListObjectChildren
for a leaf node object.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectChildrenIterable listObjectChildrenPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectChildrenIterable responses = client.listObjectChildrenPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListObjectChildrenRequest.builder()
listObjectChildrenRequest
- A Consumer
that will call methods on ListObjectChildrenRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.NotNodeException
- Occurs when any invalid operations are performed on an object that is not a node, such as calling
ListObjectChildren
for a leaf node object.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listObjectParentPathsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListObjectParentPathsRequest.builder()
listObjectParentPathsRequest
- A Consumer
that will call methods on ListObjectParentPathsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectParentPathsIterable listObjectParentPathsPaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listObjectParentPaths(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentPathsRequest)
operation.
listObjectParentPathsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectParentPathsIterable listObjectParentPathsPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentPathsIterable responses = client.listObjectParentPathsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListObjectParentPathsRequest.builder()
listObjectParentPathsRequest
- A Consumer
that will call methods on ListObjectParentPathsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listObjectParentsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.CannotListParentOfRootException
- Cannot list the parents of a Directory root.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListObjectParentsRequest.builder()
listObjectParentsRequest
- A Consumer
that will call methods on ListObjectParentsRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.CannotListParentOfRootException
- Cannot list the parents of a Directory root.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectParentsIterable listObjectParentsPaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listObjectParents(software.amazon.awssdk.services.clouddirectory.model.ListObjectParentsRequest)
operation.
listObjectParentsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.CannotListParentOfRootException
- Cannot list the parents of a Directory root.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectParentsIterable listObjectParentsPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectParentsIterable responses = client.listObjectParentsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListObjectParentsRequest.builder()
listObjectParentsRequest
- A Consumer
that will call methods on ListObjectParentsRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.CannotListParentOfRootException
- Cannot list the parents of a Directory root.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listObjectPoliciesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListObjectPoliciesRequest.builder()
listObjectPoliciesRequest
- A Consumer
that will call methods on ListObjectPoliciesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectPoliciesIterable listObjectPoliciesPaginator(ListObjectPoliciesRequest 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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listObjectPolicies(software.amazon.awssdk.services.clouddirectory.model.ListObjectPoliciesRequest)
operation.
listObjectPoliciesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListObjectPoliciesIterable listObjectPoliciesPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListObjectPoliciesIterable responses = client.listObjectPoliciesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListObjectPoliciesRequest.builder()
listObjectPoliciesRequest
- A Consumer
that will call methods on ListObjectPoliciesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
listOutgoingTypedLinksRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the ListOutgoingTypedLinksRequest.Builder
avoiding the
need to create one manually via ListOutgoingTypedLinksRequest.builder()
listOutgoingTypedLinksRequest
- A Consumer
that will call methods on ListOutgoingTypedLinksRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listPolicyAttachmentsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListPolicyAttachmentsRequest.builder()
listPolicyAttachmentsRequest
- A Consumer
that will call methods on ListPolicyAttachmentsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPolicyAttachmentsIterable listPolicyAttachmentsPaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPolicyAttachments(software.amazon.awssdk.services.clouddirectory.model.ListPolicyAttachmentsRequest)
operation.
listPolicyAttachmentsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPolicyAttachmentsIterable listPolicyAttachmentsPaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListPolicyAttachmentsIterable responses = client.listPolicyAttachmentsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListPolicyAttachmentsRequest.builder()
listPolicyAttachmentsRequest
- A Consumer
that will call methods on ListPolicyAttachmentsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.NotPolicyException
- Indicates that the requested operation can only operate on policy objects.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublishedSchemaArnsResponse listPublishedSchemaArns() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each published schema Amazon Resource Name (ARN).
InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPublishedSchemaArns(ListPublishedSchemaArnsRequest)
,
AWS API Documentationdefault ListPublishedSchemaArnsResponse listPublishedSchemaArns(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each published schema Amazon Resource Name (ARN).
listPublishedSchemaArnsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublishedSchemaArnsResponse listPublishedSchemaArns(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each published schema Amazon Resource Name (ARN).
This is a convenience which creates an instance of the ListPublishedSchemaArnsRequest.Builder
avoiding
the need to create one manually via ListPublishedSchemaArnsRequest.builder()
listPublishedSchemaArnsRequest
- A Consumer
that will call methods on ListPublishedSchemaArnsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublishedSchemaArnsIterable listPublishedSchemaArnsPaginator() throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each published schema Amazon Resource Name (ARN).
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.
InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
listPublishedSchemaArnsPaginator(ListPublishedSchemaArnsRequest)
,
AWS API Documentationdefault ListPublishedSchemaArnsIterable listPublishedSchemaArnsPaginator(ListPublishedSchemaArnsRequest listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each published schema Amazon Resource Name (ARN).
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listPublishedSchemaArns(software.amazon.awssdk.services.clouddirectory.model.ListPublishedSchemaArnsRequest)
operation.
listPublishedSchemaArnsRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListPublishedSchemaArnsIterable listPublishedSchemaArnsPaginator(Consumer<ListPublishedSchemaArnsRequest.Builder> listPublishedSchemaArnsRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, InvalidNextTokenException, AwsServiceException, SdkClientException, CloudDirectoryException
Retrieves each published schema Amazon Resource Name (ARN).
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListPublishedSchemaArnsIterable responses = client.listPublishedSchemaArnsPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListPublishedSchemaArnsRequest.builder()
listPublishedSchemaArnsRequest
- A Consumer
that will call methods on ListPublishedSchemaArnsRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
listTagsForResourceRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceIterable listTagsForResourcePaginator(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.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTagsForResource(software.amazon.awssdk.services.clouddirectory.model.ListTagsForResourceRequest)
operation.
listTagsForResourceRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTagsForResourceIterable listTagsForResourcePaginator(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 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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListTagsForResourceIterable responses = client.listTagsForResourcePaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListTagsForResourceRequest.builder()
listTagsForResourceRequest
- A Consumer
that will call methods on ListTagsForResourceRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
listTypedLinkFacetAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the ListTypedLinkFacetAttributesRequest.Builder
avoiding the need to create one manually via ListTypedLinkFacetAttributesRequest.builder()
listTypedLinkFacetAttributesRequest
- A Consumer
that will call methods on ListTypedLinkFacetAttributesRequest.Builder
to create
a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTypedLinkFacetAttributesIterable listTypedLinkFacetAttributesPaginator(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 link.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTypedLinkFacetAttributes(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetAttributesRequest)
operation.
listTypedLinkFacetAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTypedLinkFacetAttributesIterable listTypedLinkFacetAttributesPaginator(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 link.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetAttributesIterable responses = client.listTypedLinkFacetAttributesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListTypedLinkFacetAttributesRequest.builder()
listTypedLinkFacetAttributesRequest
- A Consumer
that will call methods on ListTypedLinkFacetAttributesRequest.Builder
to create
a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
link.
listTypedLinkFacetNamesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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
link.
This is a convenience which creates an instance of the ListTypedLinkFacetNamesRequest.Builder
avoiding
the need to create one manually via ListTypedLinkFacetNamesRequest.builder()
listTypedLinkFacetNamesRequest
- A Consumer
that will call methods on ListTypedLinkFacetNamesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTypedLinkFacetNamesIterable listTypedLinkFacetNamesPaginator(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
link.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
listTypedLinkFacetNames(software.amazon.awssdk.services.clouddirectory.model.ListTypedLinkFacetNamesRequest)
operation.
listTypedLinkFacetNamesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default ListTypedLinkFacetNamesIterable listTypedLinkFacetNamesPaginator(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
link.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.ListTypedLinkFacetNamesIterable responses = client.listTypedLinkFacetNamesPaginator(request);
responses.iterator().forEachRemaining(....);
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 via ListTypedLinkFacetNamesRequest.builder()
listTypedLinkFacetNamesRequest
- A Consumer
that will call methods on ListTypedLinkFacetNamesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 returns
ObjectIdentifier
, policyId
, and policyType
. Paths that don't lead to the
root from the target object are ignored. For more information, see Policies.
lookupPolicyRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 returns
ObjectIdentifier
, policyId
, and policyType
. 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 via LookupPolicyRequest.builder()
lookupPolicyRequest
- A Consumer
that will call methods on LookupPolicyRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default LookupPolicyIterable lookupPolicyPaginator(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 returns
ObjectIdentifier
, policyId
, and policyType
. Paths that don't lead to the
root from the target object are ignored. For more information, see Policies.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
Note: If you prefer to have control on service calls, use the
lookupPolicy(software.amazon.awssdk.services.clouddirectory.model.LookupPolicyRequest)
operation.
lookupPolicyRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default LookupPolicyIterable lookupPolicyPaginator(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 returns
ObjectIdentifier
, policyId
, and policyType
. Paths that don't lead to the
root from the target object are ignored. For more information, see Policies.
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 Stream
software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{ @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 directly
software.amazon.awssdk.services.clouddirectory.paginators.LookupPolicyIterable responses = client.lookupPolicyPaginator(request);
responses.iterator().forEachRemaining(....);
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 via LookupPolicyRequest.builder()
lookupPolicyRequest
- A Consumer
that will call methods on LookupPolicyRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.InvalidArnException
- Indicates that the provided ARN value is not valid.InvalidNextTokenException
- Indicates that the NextToken
value is not valid.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default PublishSchemaResponse publishSchema(PublishSchemaRequest publishSchemaRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, ResourceNotFoundException, SchemaAlreadyPublishedException, AwsServiceException, SdkClientException, CloudDirectoryException
Publishes a development schema with a version. If description and attributes are specified,
PublishSchema
overrides the development schema description and attributes. If not, the development
schema description and attributes are used.
publishSchemaRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.SchemaAlreadyPublishedException
- Indicates that a schema is already published.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 version. If description and attributes are specified,
PublishSchema
overrides the development schema description and attributes. If not, the development
schema description and attributes are used.
This is a convenience which creates an instance of the PublishSchemaRequest.Builder
avoiding the need to
create one manually via PublishSchemaRequest.builder()
publishSchemaRequest
- A Consumer
that will call methods on PublishSchemaRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.SchemaAlreadyPublishedException
- Indicates that a schema is already published.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
putSchemaFromJsonRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidSchemaDocException
- Indicates that the provided SchemaDoc
value is not valid.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via PutSchemaFromJsonRequest.builder()
putSchemaFromJsonRequest
- A Consumer
that will call methods on PutSchemaFromJsonRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidSchemaDocException
- Indicates that the provided SchemaDoc
value is not valid.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
removeFacetFromObjectRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via RemoveFacetFromObjectRequest.builder()
removeFacetFromObjectRequest
- A Consumer
that will call methods on RemoveFacetFromObjectRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
tagResourceRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via TagResourceRequest.builder()
tagResourceRequest
- A Consumer
that will call methods on TagResourceRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
untagResourceRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UntagResourceRequest.builder()
untagResourceRequest
- A Consumer
that will call methods on UntagResourceRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.InvalidTaggingRequestException
- Can occur for multiple reasons such as when you tag a resource that doesn’t exist or if you specify a
higher number of tags for a resource than the allowed limit. Allowed limit is 50 tags per resource.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFacetResponse updateFacet(UpdateFacetRequest updateFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidFacetUpdateException, ResourceNotFoundException, FacetNotFoundException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException
Does the following:
Adds new Attributes
, Rules
, or ObjectTypes
.
Updates existing Attributes
, Rules
, or ObjectTypes
.
Deletes existing Attributes
, Rules
, or ObjectTypes
.
updateFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidFacetUpdateException
- An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateFacetResponse updateFacet(Consumer<UpdateFacetRequest.Builder> updateFacetRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, InvalidFacetUpdateException, ResourceNotFoundException, FacetNotFoundException, InvalidRuleException, AwsServiceException, SdkClientException, CloudDirectoryException
Does the following:
Adds new Attributes
, Rules
, or ObjectTypes
.
Updates existing Attributes
, Rules
, or ObjectTypes
.
Deletes existing Attributes
, Rules
, or ObjectTypes
.
This is a convenience which creates an instance of the UpdateFacetRequest.Builder
avoiding the need to
create one manually via UpdateFacetRequest.builder()
updateFacetRequest
- A Consumer
that will call methods on UpdateFacetRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.InvalidFacetUpdateException
- An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateObjectAttributesResponse updateObjectAttributes(UpdateObjectAttributesRequest updateObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, FacetValidationException, AwsServiceException, SdkClientException, CloudDirectoryException
Updates a given object's attributes.
updateObjectAttributesRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
default UpdateObjectAttributesResponse updateObjectAttributes(Consumer<UpdateObjectAttributesRequest.Builder> updateObjectAttributesRequest) throws InternalServiceException, InvalidArnException, RetryableConflictException, ValidationException, LimitExceededException, AccessDeniedException, DirectoryNotEnabledException, ResourceNotFoundException, 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 via UpdateObjectAttributesRequest.builder()
updateObjectAttributesRequest
- A Consumer
that will call methods on UpdateObjectAttributesRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.DirectoryNotEnabledException
- An operation can only operate on a directory that is not enabled.ResourceNotFoundException
- The specified resource could not be found.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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.
updateSchemaRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 via UpdateSchemaRequest.builder()
updateSchemaRequest
- A Consumer
that will call methods on UpdateSchemaRequest.Builder
to create a request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.ResourceNotFoundException
- The specified resource could not be found.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
updateTypedLinkFacetRequest
- InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.InvalidFacetUpdateException
- An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
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 link.
This is a convenience which creates an instance of the UpdateTypedLinkFacetRequest.Builder
avoiding the
need to create one manually via UpdateTypedLinkFacetRequest.builder()
updateTypedLinkFacetRequest
- A Consumer
that will call methods on UpdateTypedLinkFacetRequest.Builder
to create a
request.InternalServiceException
- Indicates a problem that must be resolved by Amazon Web Services. This might be a transient error in
which case you can retry your request until it succeeds. Otherwise, go to the AWS Service Health Dashboard site to see if there are any
operational issues with the service.InvalidArnException
- Indicates that the provided ARN value is not valid.RetryableConflictException
- Occurs when a conflict with a previous successful write is detected. For example, if a write operation
occurs on an object and then an attempt is made to read the object using “SERIALIZABLE” consistency, this
exception may result. This generally occurs when the previous write did not have time to propagate to the
host serving the current request. A retry (with appropriate backoff logic) is the recommended response to
this exception.ValidationException
- Indicates that your request is malformed in some manner. See the exception message.LimitExceededException
- Indicates that limits are exceeded. See Limits for more
information.AccessDeniedException
- Access denied. Check your permissions.FacetValidationException
- The Facet that you provided was not well formed or could not be validated with the schema.InvalidFacetUpdateException
- An attempt to modify a Facet resulted in an invalid schema exception.ResourceNotFoundException
- The specified resource could not be found.FacetNotFoundException
- The specified Facet could not be found.InvalidRuleException
- Occurs when any of the rule parameter keys or values are invalid.SdkException
- Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException
- If any client side error occurs such as an IO related failure, failure to get credentials, etc.CloudDirectoryException
- Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException
static ServiceMetadata serviceMetadata()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.