Search
datazone_search | R Documentation |
Searches for assets in Amazon DataZone¶
Description¶
Searches for assets in Amazon DataZone.
Usage¶
datazone_search(additionalAttributes, domainIdentifier, filters,
maxResults, nextToken, owningProjectIdentifier, searchIn, searchScope,
searchText, sort)
Arguments¶
additionalAttributes
Specifies additional attributes for the
search
action.domainIdentifier
[required] The identifier of the Amazon DataZone domain.
filters
Specifies the search filters.
maxResults
The maximum number of results to return in a single call to
search
. When the number of results to be listed is greater than the value ofMaxResults
, the response contains aNextToken
value that you can use in a subsequent call tosearch
to list the next set of results.nextToken
When the number of results is greater than the default value for the
MaxResults
parameter, or if you explicitly specify a value forMaxResults
that is less than the number of results, the response includes a pagination token namedNextToken
. You can specify thisNextToken
value in a subsequent call tosearch
to list the next set of results.owningProjectIdentifier
The identifier of the owning project specified for the search.
searchIn
The details of the search.
searchScope
[required] The scope of the search.
searchText
Specifies the text for which to search.
sort
Specifies the way in which the search results are to be sorted.
Value¶
A list with the following syntax:
list(
items = list(
list(
assetItem = list(
additionalAttributes = list(
formsOutput = list(
list(
content = "string",
formName = "string",
typeName = "string",
typeRevision = "string"
)
),
latestTimeSeriesDataPointFormsOutput = list(
list(
contentSummary = "string",
formName = "string",
id = "string",
timestamp = as.POSIXct(
"2015-01-01"
),
typeIdentifier = "string",
typeRevision = "string"
)
),
readOnlyFormsOutput = list(
list(
content = "string",
formName = "string",
typeName = "string",
typeRevision = "string"
)
)
),
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
description = "string",
domainId = "string",
externalIdentifier = "string",
firstRevisionCreatedAt = as.POSIXct(
"2015-01-01"
),
firstRevisionCreatedBy = "string",
glossaryTerms = list(
"string"
),
identifier = "string",
name = "string",
owningProjectId = "string",
typeIdentifier = "string",
typeRevision = "string"
),
dataProductItem = list(
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
description = "string",
domainId = "string",
firstRevisionCreatedAt = as.POSIXct(
"2015-01-01"
),
firstRevisionCreatedBy = "string",
glossaryTerms = list(
"string"
),
id = "string",
name = "string",
owningProjectId = "string"
),
glossaryItem = list(
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
description = "string",
domainId = "string",
id = "string",
name = "string",
owningProjectId = "string",
status = "DISABLED"|"ENABLED",
updatedAt = as.POSIXct(
"2015-01-01"
),
updatedBy = "string"
),
glossaryTermItem = list(
createdAt = as.POSIXct(
"2015-01-01"
),
createdBy = "string",
domainId = "string",
glossaryId = "string",
id = "string",
longDescription = "string",
name = "string",
shortDescription = "string",
status = "ENABLED"|"DISABLED",
termRelations = list(
classifies = list(
"string"
),
isA = list(
"string"
)
),
updatedAt = as.POSIXct(
"2015-01-01"
),
updatedBy = "string"
)
)
),
nextToken = "string",
totalMatchCount = 123
)
Request syntax¶
svc$search(
additionalAttributes = list(
"FORMS"|"TIME_SERIES_DATA_POINT_FORMS"
),
domainIdentifier = "string",
filters = list(
and = list(
list()
),
filter = list(
attribute = "string",
value = "string"
),
or = list(
list()
)
),
maxResults = 123,
nextToken = "string",
owningProjectIdentifier = "string",
searchIn = list(
list(
attribute = "string"
)
),
searchScope = "ASSET"|"GLOSSARY"|"GLOSSARY_TERM"|"DATA_PRODUCT",
searchText = "string",
sort = list(
attribute = "string",
order = "ASCENDING"|"DESCENDING"
)
)