Struct aws_sdk_clouddirectory::client::fluent_builders::ListObjectParentPaths

pub struct ListObjectParentPaths { /* private fields */ }

Fluent builder constructing a request to ListObjectParentPaths.

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.

Implementations

impl ListObjectParentPaths

pub async fn send(
    self
) -> Result<ListObjectParentPathsOutput, SdkError<ListObjectParentPathsError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn into_paginator(self) -> ListObjectParentPathsPaginator

Create a paginator for this request

Paginators are used by calling send().await which returns a Stream.

pub fn directory_arn(self, input: impl Into<String>) -> Self

The ARN of the directory to which the parent path applies.

pub fn set_directory_arn(self, input: Option<String>) -> Self

The ARN of the directory to which the parent path applies.

pub fn object_reference(self, input: ObjectReference) -> Self

The reference that identifies the object whose parent paths are listed.

pub fn set_object_reference(self, input: Option<ObjectReference>) -> Self

The reference that identifies the object whose parent paths are listed.

pub fn next_token(self, input: impl Into<String>) -> Self

The pagination token.

pub fn set_next_token(self, input: Option<String>) -> Self

The pagination token.

pub fn max_results(self, input: i32) -> Self

The maximum number of items to be retrieved in a single call. This is an approximate number.

pub fn set_max_results(self, input: Option<i32>) -> Self

The maximum number of items to be retrieved in a single call. This is an approximate number.

Trait Implementations

impl Clone for ListObjectParentPaths

fn clone(&self) -> ListObjectParentPaths

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListObjectParentPaths

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.