| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.CloudDirectory.ListObjectAttributes
Description
Lists all attributes that are associated with an object.
This operation returns paginated results.
Synopsis
- data ListObjectAttributes = ListObjectAttributes' {}
- newListObjectAttributes :: Text -> ObjectReference -> ListObjectAttributes
- listObjectAttributes_facetFilter :: Lens' ListObjectAttributes (Maybe SchemaFacet)
- listObjectAttributes_consistencyLevel :: Lens' ListObjectAttributes (Maybe ConsistencyLevel)
- listObjectAttributes_nextToken :: Lens' ListObjectAttributes (Maybe Text)
- listObjectAttributes_maxResults :: Lens' ListObjectAttributes (Maybe Natural)
- listObjectAttributes_directoryArn :: Lens' ListObjectAttributes Text
- listObjectAttributes_objectReference :: Lens' ListObjectAttributes ObjectReference
- data ListObjectAttributesResponse = ListObjectAttributesResponse' {}
- newListObjectAttributesResponse :: Int -> ListObjectAttributesResponse
- listObjectAttributesResponse_nextToken :: Lens' ListObjectAttributesResponse (Maybe Text)
- listObjectAttributesResponse_attributes :: Lens' ListObjectAttributesResponse (Maybe [AttributeKeyAndValue])
- listObjectAttributesResponse_httpStatus :: Lens' ListObjectAttributesResponse Int
Creating a Request
data ListObjectAttributes Source #
See: newListObjectAttributes smart constructor.
Constructors
| ListObjectAttributes' | |
Fields
| |
Instances
newListObjectAttributes Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> 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:facetFilter:ListObjectAttributes', listObjectAttributes_facetFilter - Used to filter the list of object attributes that are associated with a
certain facet.
$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.
$sel:nextToken:ListObjectAttributes', listObjectAttributes_nextToken - The pagination token.
$sel:maxResults:ListObjectAttributes', listObjectAttributes_maxResults - The maximum number of items to be retrieved in a single call. This is an
approximate number.
$sel:directoryArn:ListObjectAttributes', listObjectAttributes_directoryArn - The Amazon Resource Name (ARN) that is associated with the Directory
where the object resides. For more information, see arns.
$sel:objectReference:ListObjectAttributes', listObjectAttributes_objectReference - The reference that identifies the object whose attributes will be
listed.
Request Lenses
listObjectAttributes_facetFilter :: Lens' ListObjectAttributes (Maybe SchemaFacet) Source #
Used to filter the list of object attributes that are associated with a certain facet.
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_nextToken :: Lens' ListObjectAttributes (Maybe Text) Source #
The pagination token.
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_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
| |
Instances
newListObjectAttributesResponse Source #
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:
$sel:nextToken:ListObjectAttributes', listObjectAttributesResponse_nextToken - The pagination token.
$sel:attributes:ListObjectAttributesResponse', listObjectAttributesResponse_attributes - Attributes map that is associated with the object. AttributeArn is the
key, and attribute value is the value.
$sel:httpStatus:ListObjectAttributesResponse', listObjectAttributesResponse_httpStatus - The response's http status code.
Response Lenses
listObjectAttributesResponse_nextToken :: Lens' ListObjectAttributesResponse (Maybe Text) Source #
The pagination token.
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_httpStatus :: Lens' ListObjectAttributesResponse Int Source #
The response's http status code.