Amazonka.CloudDirectory.ListIncomingTypedLinks

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.

Creating a Request

data ListIncomingTypedLinks

See: newListIncomingTypedLinks smart constructor.

Constructors

ListIncomingTypedLinks'

Fields

• consistencyLevel :: Maybe ConsistencyLevel

  The consistency level to execute the request at.

• filterAttributeRanges :: Maybe [TypedLinkAttributeRange]

  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.

• filterTypedLink :: Maybe TypedLinkSchemaAndFacetName

  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.

• maxResults :: Maybe Natural

  The maximum number of results to retrieve.

• nextToken :: Maybe Text

  The pagination token.

• directoryArn :: Text

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

• objectReference :: ObjectReference

  Reference that identifies the object whose attributes will be listed.

Instances

ToJSON ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

toJSON :: ListIncomingTypedLinks -> Value

toEncoding :: ListIncomingTypedLinks -> Encoding

toJSONList :: [ListIncomingTypedLinks] -> Value

toEncodingList :: [ListIncomingTypedLinks] -> Encoding

ToHeaders ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

toHeaders :: ListIncomingTypedLinks -> [Header]

ToPath ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

toPath :: ListIncomingTypedLinks -> ByteString

ToQuery ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

toQuery :: ListIncomingTypedLinks -> QueryString

AWSPager ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

page :: ListIncomingTypedLinks -> AWSResponse ListIncomingTypedLinks -> Maybe ListIncomingTypedLinks

AWSRequest ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Associated Types

type AWSResponse ListIncomingTypedLinks

Methods

request :: (Service -> Service) -> ListIncomingTypedLinks -> Request ListIncomingTypedLinks

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListIncomingTypedLinks -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListIncomingTypedLinks)))

Generic ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Associated Types

type Rep ListIncomingTypedLinks :: Type -> Type

Methods

from :: ListIncomingTypedLinks -> Rep ListIncomingTypedLinks x

to :: Rep ListIncomingTypedLinks x -> ListIncomingTypedLinks

Read ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

readsPrec :: Int -> ReadS ListIncomingTypedLinks

readList :: ReadS [ListIncomingTypedLinks]

readPrec :: ReadPrec ListIncomingTypedLinks

readListPrec :: ReadPrec [ListIncomingTypedLinks]

Show ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

showsPrec :: Int -> ListIncomingTypedLinks -> ShowS

show :: ListIncomingTypedLinks -> String

showList :: [ListIncomingTypedLinks] -> ShowS

NFData ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

rnf :: ListIncomingTypedLinks -> ()

Eq ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

(==) :: ListIncomingTypedLinks -> ListIncomingTypedLinks -> Bool

(/=) :: ListIncomingTypedLinks -> ListIncomingTypedLinks -> Bool

Hashable ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

hashWithSalt :: Int -> ListIncomingTypedLinks -> Int

hash :: ListIncomingTypedLinks -> Int

type AWSResponse ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

type AWSResponse ListIncomingTypedLinks = ListIncomingTypedLinksResponse

type Rep ListIncomingTypedLinks

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

type Rep ListIncomingTypedLinks = D1 ('MetaData "ListIncomingTypedLinks" "Amazonka.CloudDirectory.ListIncomingTypedLinks" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListIncomingTypedLinks'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "consistencyLevel") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ConsistencyLevel)) :*: (S1 ('MetaSel ('Just "filterAttributeRanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TypedLinkAttributeRange])) :*: S1 ('MetaSel ('Just "filterTypedLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TypedLinkSchemaAndFacetName)))) :*: ((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)))))

newListIncomingTypedLinks

Arguments

:: Text

ListIncomingTypedLinks

-> 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:consistencyLevel:ListIncomingTypedLinks', listIncomingTypedLinks_consistencyLevel - The consistency level to execute the request at.

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.

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.

ListIncomingTypedLinks, listIncomingTypedLinks_maxResults - The maximum number of results to retrieve.

ListIncomingTypedLinks, listIncomingTypedLinks_nextToken - The pagination token.

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

ListIncomingTypedLinks, listIncomingTypedLinks_objectReference - Reference that identifies the object whose attributes will be listed.

Request Lenses

listIncomingTypedLinks_consistencyLevel :: Lens' ListIncomingTypedLinks (Maybe ConsistencyLevel)

The consistency level to execute the request at.

listIncomingTypedLinks_filterAttributeRanges :: Lens' ListIncomingTypedLinks (Maybe [TypedLinkAttributeRange])

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_filterTypedLink :: Lens' ListIncomingTypedLinks (Maybe TypedLinkSchemaAndFacetName)

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)

The maximum number of results to retrieve.

listIncomingTypedLinks_nextToken :: Lens' ListIncomingTypedLinks (Maybe Text)

The pagination token.

listIncomingTypedLinks_directoryArn :: Lens' ListIncomingTypedLinks Text

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

listIncomingTypedLinks_objectReference :: Lens' ListIncomingTypedLinks ObjectReference

Reference that identifies the object whose attributes will be listed.

Destructuring the Response

data ListIncomingTypedLinksResponse

See: newListIncomingTypedLinksResponse smart constructor.

Constructors

ListIncomingTypedLinksResponse'

Fields

• linkSpecifiers :: Maybe [TypedLinkSpecifier]

  Returns one or more typed link specifiers as output.

• nextToken :: Maybe Text

  The pagination token.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListIncomingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Associated Types

type Rep ListIncomingTypedLinksResponse :: Type -> Type

Methods

from :: ListIncomingTypedLinksResponse -> Rep ListIncomingTypedLinksResponse x

to :: Rep ListIncomingTypedLinksResponse x -> ListIncomingTypedLinksResponse

Read ListIncomingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

readsPrec :: Int -> ReadS ListIncomingTypedLinksResponse

readList :: ReadS [ListIncomingTypedLinksResponse]

readPrec :: ReadPrec ListIncomingTypedLinksResponse

readListPrec :: ReadPrec [ListIncomingTypedLinksResponse]

Show ListIncomingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

showsPrec :: Int -> ListIncomingTypedLinksResponse -> ShowS

show :: ListIncomingTypedLinksResponse -> String

showList :: [ListIncomingTypedLinksResponse] -> ShowS

NFData ListIncomingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

rnf :: ListIncomingTypedLinksResponse -> ()

Eq ListIncomingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

Methods

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

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

type Rep ListIncomingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListIncomingTypedLinks

type Rep ListIncomingTypedLinksResponse = D1 ('MetaData "ListIncomingTypedLinksResponse" "Amazonka.CloudDirectory.ListIncomingTypedLinks" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" '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

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:

ListIncomingTypedLinksResponse, listIncomingTypedLinksResponse_linkSpecifiers - Returns one or more typed link specifiers as output.

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])

Returns one or more typed link specifiers as output.

listIncomingTypedLinksResponse_nextToken :: Lens' ListIncomingTypedLinksResponse (Maybe Text)

The pagination token.

listIncomingTypedLinksResponse_httpStatus :: Lens' ListIncomingTypedLinksResponse Int

The response's http status code.