Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CloudDirectory.ListObjectAttributes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists all attributes that are associated with an object.

This operation returns paginated results.

Synopsis

Creating a Request

data ListObjectAttributes Source #

See: newListObjectAttributes smart constructor.

Constructors

ListObjectAttributes'

Fields

consistencyLevel :: Maybe 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.
facetFilter :: Maybe SchemaFacet
Used to filter the list of object attributes that are associated with a certain facet.
maxResults :: Maybe Natural
The maximum number of items to be retrieved in a single call. This is an approximate number.
nextToken :: Maybe Text
The pagination token.
directoryArn :: Text
The Amazon Resource Name (ARN) that is associated with the Directory where the object resides. For more information, see arns.
objectReference :: ObjectReference
The reference that identifies the object whose attributes will be listed.

Instances

Instances details

ToJSON ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods toJSON :: ListObjectAttributes -> Value # toEncoding :: ListObjectAttributes -> Encoding # toJSONList :: [ListObjectAttributes] -> Value # toEncodingList :: [ListObjectAttributes] -> Encoding #
ToHeaders ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods toHeaders :: ListObjectAttributes -> [Header] #
ToPath ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods toPath :: ListObjectAttributes -> ByteString #
ToQuery ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods toQuery :: ListObjectAttributes -> QueryString #
AWSPager ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods page :: ListObjectAttributes -> AWSResponse ListObjectAttributes -> Maybe ListObjectAttributes #
AWSRequest ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Associated Types type AWSResponse ListObjectAttributes # Methods request :: (Service -> Service) -> ListObjectAttributes -> Request ListObjectAttributes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListObjectAttributes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListObjectAttributes))) #
Generic ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Associated Types type Rep ListObjectAttributes :: Type -> Type # Methods from :: ListObjectAttributes -> Rep ListObjectAttributes x # to :: Rep ListObjectAttributes x -> ListObjectAttributes #
Read ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods readsPrec :: Int -> ReadS ListObjectAttributes # readList :: ReadS [ListObjectAttributes] # readPrec :: ReadPrec ListObjectAttributes # readListPrec :: ReadPrec [ListObjectAttributes] #
Show ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods showsPrec :: Int -> ListObjectAttributes -> ShowS # show :: ListObjectAttributes -> String # showList :: [ListObjectAttributes] -> ShowS #
NFData ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods rnf :: ListObjectAttributes -> () #
Eq ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods (==) :: ListObjectAttributes -> ListObjectAttributes -> Bool # (/=) :: ListObjectAttributes -> ListObjectAttributes -> Bool #
Hashable ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods hashWithSalt :: Int -> ListObjectAttributes -> Int # hash :: ListObjectAttributes -> Int #
type AWSResponse ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes type AWSResponse ListObjectAttributes = ListObjectAttributesResponse
type Rep ListObjectAttributes Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes type Rep ListObjectAttributes = D1 ('MetaData "ListObjectAttributes" "Amazonka.CloudDirectory.ListObjectAttributes" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListObjectAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :: (S1 ('MetaSel ('Just "facetFilter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SchemaFacet)) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "directoryArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "objectReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))))

newListObjectAttributes Source #

Arguments

:: Text	`ListObjectAttributes`
-> ObjectReference	`ListObjectAttributes`
-> ListObjectAttributes

Create a value of ListObjectAttributes 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:ListObjectAttributes', listObjectAttributes_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.

ListObjectAttributes, listObjectAttributes_facetFilter - Used to filter the list of object attributes that are associated with a certain facet.

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

ListObjectAttributes, listObjectAttributes_nextToken - The pagination token.

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

ListObjectAttributes, listObjectAttributes_objectReference - The reference that identifies the object whose attributes will be listed.

Request Lenses

listObjectAttributes_consistencyLevel :: Lens' ListObjectAttributes (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.

listObjectAttributes_facetFilter :: Lens' ListObjectAttributes (Maybe SchemaFacet) Source #

Used to filter the list of object attributes that are associated with a certain facet.

listObjectAttributes_maxResults :: Lens' ListObjectAttributes (Maybe Natural) Source #

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

listObjectAttributes_nextToken :: Lens' ListObjectAttributes (Maybe Text) Source #

The pagination token.

listObjectAttributes_directoryArn :: Lens' ListObjectAttributes Text Source #

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

listObjectAttributes_objectReference :: Lens' ListObjectAttributes ObjectReference Source #

The reference that identifies the object whose attributes will be listed.

Destructuring the Response

data ListObjectAttributesResponse Source #

See: newListObjectAttributesResponse smart constructor.

Constructors

ListObjectAttributesResponse'
Fields attributes :: Maybe [AttributeKeyAndValue] Attributes map that is associated with the object. `AttributeArn` is the key, and attribute value is the value. nextToken :: Maybe Text The pagination token. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic ListObjectAttributesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Associated Types type Rep ListObjectAttributesResponse :: Type -> Type # Methods from :: ListObjectAttributesResponse -> Rep ListObjectAttributesResponse x # to :: Rep ListObjectAttributesResponse x -> ListObjectAttributesResponse #
Read ListObjectAttributesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods readsPrec :: Int -> ReadS ListObjectAttributesResponse # readList :: ReadS [ListObjectAttributesResponse] # readPrec :: ReadPrec ListObjectAttributesResponse # readListPrec :: ReadPrec [ListObjectAttributesResponse] #
Show ListObjectAttributesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods showsPrec :: Int -> ListObjectAttributesResponse -> ShowS # show :: ListObjectAttributesResponse -> String # showList :: [ListObjectAttributesResponse] -> ShowS #
NFData ListObjectAttributesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods rnf :: ListObjectAttributesResponse -> () #
Eq ListObjectAttributesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes Methods (==) :: ListObjectAttributesResponse -> ListObjectAttributesResponse -> Bool # (/=) :: ListObjectAttributesResponse -> ListObjectAttributesResponse -> Bool #
type Rep ListObjectAttributesResponse Source #
Instance details Defined in Amazonka.CloudDirectory.ListObjectAttributes type Rep ListObjectAttributesResponse = D1 ('MetaData "ListObjectAttributesResponse" "Amazonka.CloudDirectory.ListObjectAttributes" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListObjectAttributesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AttributeKeyAndValue])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListObjectAttributesResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListObjectAttributesResponse'`
-> ListObjectAttributesResponse

Create a value of ListObjectAttributesResponse 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:

ListObjectAttributesResponse, listObjectAttributesResponse_attributes - Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.

ListObjectAttributes, listObjectAttributesResponse_nextToken - The pagination token.

$sel:httpStatus:ListObjectAttributesResponse', listObjectAttributesResponse_httpStatus - The response's http status code.

Response Lenses

listObjectAttributesResponse_attributes :: Lens' ListObjectAttributesResponse (Maybe [AttributeKeyAndValue]) Source #

Attributes map that is associated with the object. AttributeArn is the key, and attribute value is the value.

listObjectAttributesResponse_nextToken :: Lens' ListObjectAttributesResponse (Maybe Text) Source #

The pagination token.

listObjectAttributesResponse_httpStatus :: Lens' ListObjectAttributesResponse Int Source #

The response's http status code.