libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudDirectory.ListObjectParents

Description

Lists parent objects that are associated with a given object in pagination fashion.

Synopsis

Creating a Request

data ListObjectParents Source #

See: newListObjectParents smart constructor.

Constructors

ListObjectParents' 

Fields

Instances

Instances details
Eq ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Read ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Show ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Generic ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Associated Types

type Rep ListObjectParents :: Type -> Type #

NFData ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Methods

rnf :: ListObjectParents -> () #

Hashable ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

ToJSON ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

AWSRequest ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Associated Types

type AWSResponse ListObjectParents #

ToHeaders ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

ToPath ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

ToQuery ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

type Rep ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

type Rep ListObjectParents = D1 ('MetaData "ListObjectParents" "Amazonka.CloudDirectory.ListObjectParents" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "ListObjectParents'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :*: (S1 ('MetaSel ('Just "includeAllLinksToEachParent") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "objectReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))))
type AWSResponse ListObjectParents Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

newListObjectParents Source #

Create a value of ListObjectParents with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:consistencyLevel:ListObjectParents', listObjectParents_consistencyLevel - Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

$sel:includeAllLinksToEachParent:ListObjectParents', listObjectParents_includeAllLinksToEachParent - When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

$sel:nextToken:ListObjectParents', listObjectParents_nextToken - The pagination token.

$sel:maxResults:ListObjectParents', listObjectParents_maxResults - The maximum number of items to be retrieved in a single call. This is an approximate number.

$sel:directoryArn:ListObjectParents', listObjectParents_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

$sel:objectReference:ListObjectParents', listObjectParents_objectReference - The reference that identifies the object for which parent objects are being listed.

Request Lenses

listObjectParents_consistencyLevel :: Lens' ListObjectParents (Maybe ConsistencyLevel) Source #

Represents the manner and timing in which the successful write or update of an object is reflected in a subsequent read operation of that same object.

listObjectParents_includeAllLinksToEachParent :: Lens' ListObjectParents (Maybe Bool) Source #

When set to True, returns all ListObjectParentsResponse$ParentLinks. There could be multiple links between a parent-child pair.

listObjectParents_maxResults :: Lens' ListObjectParents (Maybe Natural) Source #

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

listObjectParents_directoryArn :: Lens' ListObjectParents Text Source #

The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.

listObjectParents_objectReference :: Lens' ListObjectParents ObjectReference Source #

The reference that identifies the object for which parent objects are being listed.

Destructuring the Response

data ListObjectParentsResponse Source #

See: newListObjectParentsResponse smart constructor.

Constructors

ListObjectParentsResponse' 

Fields

Instances

Instances details
Eq ListObjectParentsResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Read ListObjectParentsResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Show ListObjectParentsResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Generic ListObjectParentsResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

Associated Types

type Rep ListObjectParentsResponse :: Type -> Type #

NFData ListObjectParentsResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

type Rep ListObjectParentsResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListObjectParents

type Rep ListObjectParentsResponse = D1 ('MetaData "ListObjectParentsResponse" "Amazonka.CloudDirectory.ListObjectParents" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "ListObjectParentsResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "parents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "parentLinks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ObjectIdentifierAndLinkNameTuple])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListObjectParentsResponse Source #

Create a value of ListObjectParentsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:nextToken:ListObjectParents', listObjectParentsResponse_nextToken - The pagination token.

$sel:parents:ListObjectParentsResponse', listObjectParentsResponse_parents - The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.

$sel:parentLinks:ListObjectParentsResponse', listObjectParentsResponse_parentLinks - Returns a list of parent reference and LinkName Tuples.

$sel:httpStatus:ListObjectParentsResponse', listObjectParentsResponse_httpStatus - The response's http status code.

Response Lenses

listObjectParentsResponse_parents :: Lens' ListObjectParentsResponse (Maybe (HashMap Text Text)) Source #

The parent structure, which is a map with key as the ObjectIdentifier and LinkName as the value.