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.ListIncomingTypedLinks

Description

Returns a paginated list of all the incoming 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

Creating a Request

data ListIncomingTypedLinks Source #

See: newListIncomingTypedLinks smart constructor.

Constructors

ListIncomingTypedLinks' 

Fields

Instances

newListIncomingTypedLinks Source #

Arguments

:: Text

$sel:directoryArn:ListIncomingTypedLinks'

-> ObjectReference

$sel:objectReference:ListIncomingTypedLinks'

-> ListIncomingTypedLinks 

Create a value of ListIncomingTypedLinks 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:filterAttributeRanges:ListIncomingTypedLinks', listIncomingTypedLinks_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.

$sel:consistencyLevel:ListIncomingTypedLinks', listIncomingTypedLinks_consistencyLevel - The consistency level to execute the request at.

$sel:nextToken:ListIncomingTypedLinks', listIncomingTypedLinks_nextToken - The pagination token.

$sel:filterTypedLink:ListIncomingTypedLinks', listIncomingTypedLinks_filterTypedLink - Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

$sel:maxResults:ListIncomingTypedLinks', listIncomingTypedLinks_maxResults - The maximum number of results to retrieve.

$sel:directoryArn:ListIncomingTypedLinks', listIncomingTypedLinks_directoryArn - The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

$sel:objectReference:ListIncomingTypedLinks', listIncomingTypedLinks_objectReference - Reference that identifies the object whose attributes will be listed.

Request Lenses

listIncomingTypedLinks_filterAttributeRanges :: Lens' ListIncomingTypedLinks (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.

listIncomingTypedLinks_consistencyLevel :: Lens' ListIncomingTypedLinks (Maybe ConsistencyLevel) Source #

The consistency level to execute the request at.

listIncomingTypedLinks_nextToken :: Lens' ListIncomingTypedLinks (Maybe Text) Source #

The pagination token.

listIncomingTypedLinks_filterTypedLink :: Lens' ListIncomingTypedLinks (Maybe TypedLinkSchemaAndFacetName) Source #

Filters are interpreted in the order of the attributes on the typed link facet, not the order in which they are supplied to any API calls.

listIncomingTypedLinks_maxResults :: Lens' ListIncomingTypedLinks (Maybe Natural) Source #

The maximum number of results to retrieve.

listIncomingTypedLinks_directoryArn :: Lens' ListIncomingTypedLinks Text Source #

The Amazon Resource Name (ARN) of the directory where you want to list the typed links.

listIncomingTypedLinks_objectReference :: Lens' ListIncomingTypedLinks ObjectReference Source #

Reference that identifies the object whose attributes will be listed.

Destructuring the Response

data ListIncomingTypedLinksResponse Source #

See: newListIncomingTypedLinksResponse smart constructor.

Constructors

ListIncomingTypedLinksResponse' 

Fields

Instances

Instances details
Eq ListIncomingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

(==) :: ListIncomingTypedLinksResponse -> ListIncomingTypedLinksResponse -> Bool #

(/=) :: ListIncomingTypedLinksResponse -> ListIncomingTypedLinksResponse -> Bool #

Read ListIncomingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

readsPrec :: Int -> ReadS ListIncomingTypedLinksResponse #

readList :: ReadS [ListIncomingTypedLinksResponse] #

readPrec :: ReadPrec ListIncomingTypedLinksResponse #

readListPrec :: ReadPrec [ListIncomingTypedLinksResponse] #

Show ListIncomingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

showsPrec :: Int -> ListIncomingTypedLinksResponse -> ShowS #

show :: ListIncomingTypedLinksResponse -> String #

showList :: [ListIncomingTypedLinksResponse] -> ShowS #

Generic ListIncomingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Associated Types

type Rep ListIncomingTypedLinksResponse :: Type -> Type #

Methods

from :: ListIncomingTypedLinksResponse -> Rep ListIncomingTypedLinksResponse x #

to :: Rep ListIncomingTypedLinksResponse x -> ListIncomingTypedLinksResponse #

NFData ListIncomingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

rnf :: ListIncomingTypedLinksResponse -> () #

type Rep ListIncomingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

type Rep ListIncomingTypedLinksResponse = D1 ('MetaData "ListIncomingTypedLinksResponse" "Amazonka.CloudDirectory.ListIncomingTypedLinks" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "ListIncomingTypedLinksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "linkSpecifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TypedLinkSpecifier])) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListIncomingTypedLinksResponse Source #

Arguments

:: Int

$sel:httpStatus:ListIncomingTypedLinksResponse'

-> ListIncomingTypedLinksResponse 

Create a value of ListIncomingTypedLinksResponse 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:linkSpecifiers:ListIncomingTypedLinksResponse', listIncomingTypedLinksResponse_linkSpecifiers - Returns one or more typed link specifiers as output.

$sel:nextToken:ListIncomingTypedLinks', listIncomingTypedLinksResponse_nextToken - The pagination token.

$sel:httpStatus:ListIncomingTypedLinksResponse', listIncomingTypedLinksResponse_httpStatus - The response's http status code.

Response Lenses

listIncomingTypedLinksResponse_linkSpecifiers :: Lens' ListIncomingTypedLinksResponse (Maybe [TypedLinkSpecifier]) Source #

Returns one or more typed link specifiers as output.

listIncomingTypedLinksResponse_nextToken :: Lens' ListIncomingTypedLinksResponse (Maybe Text) Source #

The pagination token.

listIncomingTypedLinksResponse_httpStatus :: Lens' ListIncomingTypedLinksResponse Int Source #

The response's http status code.