Amazonka.CloudDirectory.ListOutgoingTypedLinks

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.

Creating a Request

data ListOutgoingTypedLinks

See: newListOutgoingTypedLinks smart constructor.

Constructors

ListOutgoingTypedLinks'

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 defined on the typed link facet, not the order 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

  A reference that identifies the object whose attributes will be listed.

Instances

ToJSON ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

toJSON :: ListOutgoingTypedLinks -> Value

toEncoding :: ListOutgoingTypedLinks -> Encoding

toJSONList :: [ListOutgoingTypedLinks] -> Value

toEncodingList :: [ListOutgoingTypedLinks] -> Encoding

ToHeaders ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

toHeaders :: ListOutgoingTypedLinks -> [Header]

ToPath ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

toPath :: ListOutgoingTypedLinks -> ByteString

ToQuery ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

toQuery :: ListOutgoingTypedLinks -> QueryString

AWSPager ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

page :: ListOutgoingTypedLinks -> AWSResponse ListOutgoingTypedLinks -> Maybe ListOutgoingTypedLinks

AWSRequest ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Associated Types

type AWSResponse ListOutgoingTypedLinks

Methods

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

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

Generic ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Associated Types

type Rep ListOutgoingTypedLinks :: Type -> Type

Methods

from :: ListOutgoingTypedLinks -> Rep ListOutgoingTypedLinks x

to :: Rep ListOutgoingTypedLinks x -> ListOutgoingTypedLinks

Read ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

readsPrec :: Int -> ReadS ListOutgoingTypedLinks

readList :: ReadS [ListOutgoingTypedLinks]

readPrec :: ReadPrec ListOutgoingTypedLinks

readListPrec :: ReadPrec [ListOutgoingTypedLinks]

Show ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

showsPrec :: Int -> ListOutgoingTypedLinks -> ShowS

show :: ListOutgoingTypedLinks -> String

showList :: [ListOutgoingTypedLinks] -> ShowS

NFData ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

rnf :: ListOutgoingTypedLinks -> ()

Eq ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

(==) :: ListOutgoingTypedLinks -> ListOutgoingTypedLinks -> Bool

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

Hashable ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

hashWithSalt :: Int -> ListOutgoingTypedLinks -> Int

hash :: ListOutgoingTypedLinks -> Int

type AWSResponse ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

type AWSResponse ListOutgoingTypedLinks = ListOutgoingTypedLinksResponse

type Rep ListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

type Rep ListOutgoingTypedLinks = D1 ('MetaData "ListOutgoingTypedLinks" "Amazonka.CloudDirectory.ListOutgoingTypedLinks" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListOutgoingTypedLinks'" '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)))))

newListOutgoingTypedLinks

Arguments

:: Text

ListOutgoingTypedLinks

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

The consistency level to execute the request at.

listOutgoingTypedLinks_filterAttributeRanges :: Lens' ListOutgoingTypedLinks (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.

listOutgoingTypedLinks_filterTypedLink :: Lens' ListOutgoingTypedLinks (Maybe TypedLinkSchemaAndFacetName)

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)

The maximum number of results to retrieve.

listOutgoingTypedLinks_nextToken :: Lens' ListOutgoingTypedLinks (Maybe Text)

The pagination token.

listOutgoingTypedLinks_directoryArn :: Lens' ListOutgoingTypedLinks Text

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

listOutgoingTypedLinks_objectReference :: Lens' ListOutgoingTypedLinks ObjectReference

A reference that identifies the object whose attributes will be listed.

Destructuring the Response

data ListOutgoingTypedLinksResponse

See: newListOutgoingTypedLinksResponse smart constructor.

Constructors

ListOutgoingTypedLinksResponse'

Fields

• nextToken :: Maybe Text

  The pagination token.

• typedLinkSpecifiers :: Maybe [TypedLinkSpecifier]

  Returns a typed link specifier as output.

• httpStatus :: Int

  The response's http status code.

Instances

Generic ListOutgoingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Associated Types

type Rep ListOutgoingTypedLinksResponse :: Type -> Type

Methods

from :: ListOutgoingTypedLinksResponse -> Rep ListOutgoingTypedLinksResponse x

to :: Rep ListOutgoingTypedLinksResponse x -> ListOutgoingTypedLinksResponse

Read ListOutgoingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

readsPrec :: Int -> ReadS ListOutgoingTypedLinksResponse

readList :: ReadS [ListOutgoingTypedLinksResponse]

readPrec :: ReadPrec ListOutgoingTypedLinksResponse

readListPrec :: ReadPrec [ListOutgoingTypedLinksResponse]

Show ListOutgoingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

showsPrec :: Int -> ListOutgoingTypedLinksResponse -> ShowS

show :: ListOutgoingTypedLinksResponse -> String

showList :: [ListOutgoingTypedLinksResponse] -> ShowS

NFData ListOutgoingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

rnf :: ListOutgoingTypedLinksResponse -> ()

Eq ListOutgoingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

Methods

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

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

type Rep ListOutgoingTypedLinksResponse

Defined in Amazonka.CloudDirectory.ListOutgoingTypedLinks

type Rep ListOutgoingTypedLinksResponse = D1 ('MetaData "ListOutgoingTypedLinksResponse" "Amazonka.CloudDirectory.ListOutgoingTypedLinks" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "ListOutgoingTypedLinksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "typedLinkSpecifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [TypedLinkSpecifier])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListOutgoingTypedLinksResponse

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:

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)

The pagination token.

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

Returns a typed link specifier as output.

listOutgoingTypedLinksResponse_httpStatus :: Lens' ListOutgoingTypedLinksResponse Int

The response's http status code.