Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Documentation

data BatchListOutgoingTypedLinks

Returns a paginated list of all the outgoing TypedLinkSpecifier information for an object inside a BatchRead operation. For more information, see ListOutgoingTypedLinks and BatchReadRequest$Operations.

See: newBatchListOutgoingTypedLinks smart constructor.

Constructors

BatchListOutgoingTypedLinks'

Fields

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

• objectReference :: ObjectReference

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

Instances

ToJSON BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Methods

toJSON :: BatchListOutgoingTypedLinks -> Value

toEncoding :: BatchListOutgoingTypedLinks -> Encoding

toJSONList :: [BatchListOutgoingTypedLinks] -> Value

toEncodingList :: [BatchListOutgoingTypedLinks] -> Encoding

Generic BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Associated Types

type Rep BatchListOutgoingTypedLinks :: Type -> Type

Methods

from :: BatchListOutgoingTypedLinks -> Rep BatchListOutgoingTypedLinks x

to :: Rep BatchListOutgoingTypedLinks x -> BatchListOutgoingTypedLinks

Read BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Methods

readsPrec :: Int -> ReadS BatchListOutgoingTypedLinks

readList :: ReadS [BatchListOutgoingTypedLinks]

readPrec :: ReadPrec BatchListOutgoingTypedLinks

readListPrec :: ReadPrec [BatchListOutgoingTypedLinks]

Show BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Methods

showsPrec :: Int -> BatchListOutgoingTypedLinks -> ShowS

show :: BatchListOutgoingTypedLinks -> String

showList :: [BatchListOutgoingTypedLinks] -> ShowS

NFData BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Methods

rnf :: BatchListOutgoingTypedLinks -> ()

Eq BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Methods

(==) :: BatchListOutgoingTypedLinks -> BatchListOutgoingTypedLinks -> Bool

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

Hashable BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

Methods

hashWithSalt :: Int -> BatchListOutgoingTypedLinks -> Int

hash :: BatchListOutgoingTypedLinks -> Int

type Rep BatchListOutgoingTypedLinks

Defined in Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks

type Rep BatchListOutgoingTypedLinks = D1 ('MetaData "BatchListOutgoingTypedLinks" "Amazonka.CloudDirectory.Types.BatchListOutgoingTypedLinks" "amazonka-clouddirectory-2.0-JYRSwrX5Vm289hhbSwe2zQ" 'False) (C1 ('MetaCons "BatchListOutgoingTypedLinks'" 'PrefixI 'True) ((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 "objectReference") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectReference)))))

newBatchListOutgoingTypedLinks

Arguments

:: ObjectReference

$sel:objectReference:BatchListOutgoingTypedLinks'

-> BatchListOutgoingTypedLinks

Create a value of BatchListOutgoingTypedLinks 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:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_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:filterTypedLink:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_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:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_maxResults - The maximum number of results to retrieve.

$sel:nextToken:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_nextToken - The pagination token.

$sel:objectReference:BatchListOutgoingTypedLinks', batchListOutgoingTypedLinks_objectReference - The reference that identifies the object whose attributes will be listed.

batchListOutgoingTypedLinks_filterAttributeRanges :: Lens' BatchListOutgoingTypedLinks (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.

batchListOutgoingTypedLinks_filterTypedLink :: Lens' BatchListOutgoingTypedLinks (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.

batchListOutgoingTypedLinks_maxResults :: Lens' BatchListOutgoingTypedLinks (Maybe Natural)

The maximum number of results to retrieve.

batchListOutgoingTypedLinks_nextToken :: Lens' BatchListOutgoingTypedLinks (Maybe Text)

The pagination token.

batchListOutgoingTypedLinks_objectReference :: Lens' BatchListOutgoingTypedLinks ObjectReference

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