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

Creating a Request

data ListOutgoingTypedLinks Source #

See: newListOutgoingTypedLinks smart constructor.

Constructors

ListOutgoingTypedLinks' 

Fields

Instances

newListOutgoingTypedLinks Source #

Arguments

:: Text

$sel:directoryArn:ListOutgoingTypedLinks'

-> ObjectReference

$sel:objectReference:ListOutgoingTypedLinks'

-> 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:filterAttributeRanges: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.

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

$sel:nextToken:ListOutgoingTypedLinks', listOutgoingTypedLinks_nextToken - The pagination token.

$sel:filterTypedLink: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.

$sel:maxResults:ListOutgoingTypedLinks', listOutgoingTypedLinks_maxResults - The maximum number of results to retrieve.

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

$sel:objectReference:ListOutgoingTypedLinks', listOutgoingTypedLinks_objectReference - A reference that identifies the object whose attributes will be listed.

Request Lenses

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_consistencyLevel :: Lens' ListOutgoingTypedLinks (Maybe ConsistencyLevel) Source #

The consistency level to execute the request at.

listOutgoingTypedLinks_nextToken :: Lens' ListOutgoingTypedLinks (Maybe Text) Source #

The pagination token.

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_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

Instances details
Eq ListOutgoingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

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

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

Read ListOutgoingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

readsPrec :: Int -> ReadS ListOutgoingTypedLinksResponse #

readList :: ReadS [ListOutgoingTypedLinksResponse] #

readPrec :: ReadPrec ListOutgoingTypedLinksResponse #

readListPrec :: ReadPrec [ListOutgoingTypedLinksResponse] #

Show ListOutgoingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

showsPrec :: Int -> ListOutgoingTypedLinksResponse -> ShowS #

show :: ListOutgoingTypedLinksResponse -> String #

showList :: [ListOutgoingTypedLinksResponse] -> ShowS #

Generic ListOutgoingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Associated Types

type Rep ListOutgoingTypedLinksResponse :: Type -> Type #

Methods

from :: ListOutgoingTypedLinksResponse -> Rep ListOutgoingTypedLinksResponse x #

to :: Rep ListOutgoingTypedLinksResponse x -> ListOutgoingTypedLinksResponse #

NFData ListOutgoingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

rnf :: ListOutgoingTypedLinksResponse -> () #

type Rep ListOutgoingTypedLinksResponse Source # 
Instance details

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

type Rep ListOutgoingTypedLinksResponse = D1 ('MetaData "ListOutgoingTypedLinksResponse" "Amazonka.CloudDirectory.ListOutgoingTypedLinks" "libZSservicesZSamazonka-clouddirectoryZSamazonka-clouddirectory" 'False) (C1 ('MetaCons "ListOutgoingTypedLinksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "typedLinkSpecifiers") '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))))

newListOutgoingTypedLinksResponse Source #

Arguments

:: Int

$sel:httpStatus:ListOutgoingTypedLinksResponse'

-> ListOutgoingTypedLinksResponse 

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:

$sel:typedLinkSpecifiers:ListOutgoingTypedLinksResponse', listOutgoingTypedLinksResponse_typedLinkSpecifiers - Returns a typed link specifier as output.

$sel:nextToken:ListOutgoingTypedLinks', listOutgoingTypedLinksResponse_nextToken - The pagination token.

$sel:httpStatus:ListOutgoingTypedLinksResponse', listOutgoingTypedLinksResponse_httpStatus - The response's http status code.

Response Lenses

listOutgoingTypedLinksResponse_typedLinkSpecifiers :: Lens' ListOutgoingTypedLinksResponse (Maybe [TypedLinkSpecifier]) Source #

Returns a typed link specifier as output.

listOutgoingTypedLinksResponse_nextToken :: Lens' ListOutgoingTypedLinksResponse (Maybe Text) Source #

The pagination token.

listOutgoingTypedLinksResponse_httpStatus :: Lens' ListOutgoingTypedLinksResponse Int Source #

The response's http status code.