| 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.ListOutgoingTypedLinks
Description
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 Links.
This operation returns paginated results.
Synopsis
- data ListOutgoingTypedLinks = ListOutgoingTypedLinks' {}
- newListOutgoingTypedLinks :: Text -> ObjectReference -> ListOutgoingTypedLinks
- listOutgoingTypedLinks_consistencyLevel :: Lens' ListOutgoingTypedLinks (Maybe ConsistencyLevel)
- listOutgoingTypedLinks_filterAttributeRanges :: Lens' ListOutgoingTypedLinks (Maybe [TypedLinkAttributeRange])
- listOutgoingTypedLinks_filterTypedLink :: Lens' ListOutgoingTypedLinks (Maybe TypedLinkSchemaAndFacetName)
- listOutgoingTypedLinks_maxResults :: Lens' ListOutgoingTypedLinks (Maybe Natural)
- listOutgoingTypedLinks_nextToken :: Lens' ListOutgoingTypedLinks (Maybe Text)
- listOutgoingTypedLinks_directoryArn :: Lens' ListOutgoingTypedLinks Text
- listOutgoingTypedLinks_objectReference :: Lens' ListOutgoingTypedLinks ObjectReference
- data ListOutgoingTypedLinksResponse = ListOutgoingTypedLinksResponse' {}
- newListOutgoingTypedLinksResponse :: Int -> ListOutgoingTypedLinksResponse
- listOutgoingTypedLinksResponse_nextToken :: Lens' ListOutgoingTypedLinksResponse (Maybe Text)
- listOutgoingTypedLinksResponse_typedLinkSpecifiers :: Lens' ListOutgoingTypedLinksResponse (Maybe [TypedLinkSpecifier])
- listOutgoingTypedLinksResponse_httpStatus :: Lens' ListOutgoingTypedLinksResponse Int
Creating a Request
data ListOutgoingTypedLinks Source #
See: newListOutgoingTypedLinks smart constructor.
Constructors
| ListOutgoingTypedLinks' | |
Fields
| |
Instances
newListOutgoingTypedLinks Source #
Arguments
| :: Text | |
| -> ObjectReference | |
| -> ListOutgoingTypedLinks |
Create a value of ListOutgoingTypedLinks 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:ListOutgoingTypedLinks', listOutgoingTypedLinks_consistencyLevel - The consistency level to execute the request at.
ListOutgoingTypedLinks, listOutgoingTypedLinks_filterAttributeRanges - Provides range filters for multiple attributes. When providing ranges to
typed link selection, any inexact ranges must be specified at the end.
Any attributes that do not have a range specified are presumed to match
the entire range.
ListOutgoingTypedLinks, listOutgoingTypedLinks_filterTypedLink - Filters are interpreted in the order of the attributes defined on the
typed link facet, not the order they are supplied to any API calls.
ListOutgoingTypedLinks, listOutgoingTypedLinks_maxResults - The maximum number of results to retrieve.
ListOutgoingTypedLinks, listOutgoingTypedLinks_nextToken - The pagination token.
ListOutgoingTypedLinks, listOutgoingTypedLinks_directoryArn - The Amazon Resource Name (ARN) of the directory where you want to list
the typed links.
ListOutgoingTypedLinks, listOutgoingTypedLinks_objectReference - A reference that identifies the object whose attributes will be listed.
Request Lenses
listOutgoingTypedLinks_consistencyLevel :: Lens' ListOutgoingTypedLinks (Maybe ConsistencyLevel) Source #
The consistency level to execute the request at.
listOutgoingTypedLinks_filterAttributeRanges :: Lens' ListOutgoingTypedLinks (Maybe [TypedLinkAttributeRange]) Source #
Provides range filters for multiple attributes. When providing ranges to typed link selection, any inexact ranges must be specified at the end. Any attributes that do not have a range specified are presumed to match the entire range.
listOutgoingTypedLinks_filterTypedLink :: Lens' ListOutgoingTypedLinks (Maybe TypedLinkSchemaAndFacetName) Source #
Filters are interpreted in the order of the attributes defined on the typed link facet, not the order they are supplied to any API calls.
listOutgoingTypedLinks_maxResults :: Lens' ListOutgoingTypedLinks (Maybe Natural) Source #
The maximum number of results to retrieve.
listOutgoingTypedLinks_nextToken :: Lens' ListOutgoingTypedLinks (Maybe Text) Source #
The pagination token.
listOutgoingTypedLinks_directoryArn :: Lens' ListOutgoingTypedLinks Text Source #
The Amazon Resource Name (ARN) of the directory where you want to list the typed links.
listOutgoingTypedLinks_objectReference :: Lens' ListOutgoingTypedLinks ObjectReference Source #
A reference that identifies the object whose attributes will be listed.
Destructuring the Response
data ListOutgoingTypedLinksResponse Source #
See: newListOutgoingTypedLinksResponse smart constructor.
Constructors
| ListOutgoingTypedLinksResponse' | |
Fields
| |
Instances
newListOutgoingTypedLinksResponse Source #
Create a value of ListOutgoingTypedLinksResponse 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:
ListOutgoingTypedLinks, listOutgoingTypedLinksResponse_nextToken - The pagination token.
ListOutgoingTypedLinksResponse, listOutgoingTypedLinksResponse_typedLinkSpecifiers - Returns a typed link specifier as output.
$sel:httpStatus:ListOutgoingTypedLinksResponse', listOutgoingTypedLinksResponse_httpStatus - The response's http status code.
Response Lenses
listOutgoingTypedLinksResponse_nextToken :: Lens' ListOutgoingTypedLinksResponse (Maybe Text) Source #
The pagination token.
listOutgoingTypedLinksResponse_typedLinkSpecifiers :: Lens' ListOutgoingTypedLinksResponse (Maybe [TypedLinkSpecifier]) Source #
Returns a typed link specifier as output.
listOutgoingTypedLinksResponse_httpStatus :: Lens' ListOutgoingTypedLinksResponse Int Source #
The response's http status code.