AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon WorkDocs SearchResources API operation.

Syntax

Search-WDResource
-AdditionalResponseField <String[]>
-Filters_AncestorId <String[]>
-AuthenticationToken <String>
-Filters_ContentCategory <String[]>
-CreatedRange_EndValue <DateTime>
-ModifiedRange_EndValue <DateTime>
-SizeRange_EndValue <Int64>
-Filters_Label <String[]>
-OrderBy <SearchSortResult[]>
-OrganizationId <String>
-Filters_Principal <SearchPrincipalType[]>
-QueryScope <String[]>
-QueryText <String>
-Filters_ResourceType <String[]>
-Filters_SearchCollectionType <String[]>
-CreatedRange_StartValue <DateTime>
-ModifiedRange_StartValue <DateTime>
-SizeRange_StartValue <Int64>
-Filters_TextLocale <String[]>
-Limit <Int32>
-Marker <String>
-Select <String>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonWorkDocsConfig>

Description

Searches metadata and the content of folders, documents, document versions, and comments.

This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration.

Parameters

-AdditionalResponseField <String[]>
A list of attributes to include in the response. Used to request fields that are not normally returned in a standard response.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdditionalResponseFields
-AuthenticationToken <String>
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonWorkDocsConfig>
Amazon.PowerShell.Cmdlets.WD.AmazonWorkDocsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-CreatedRange_EndValue <DateTime>
Timestamp range end value (in epochs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_CreatedRange_EndValue
-CreatedRange_StartValue <DateTime>
Timestamp range start value (in epochs)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_CreatedRange_StartValue
-Filters_AncestorId <String[]>
Filter based on resource’s path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_AncestorIds
-Filters_ContentCategory <String[]>
Filters by content category.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_ContentCategories
-Filters_Label <String[]>
Filter by labels using exact match.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_Labels
-Filters_Principal <SearchPrincipalType[]>
Filter based on UserIds or GroupIds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_Principals
-Filters_ResourceType <String[]>
Filters based on entity type.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_ResourceTypes
-Filters_SearchCollectionType <String[]>
Filter based on file groupings.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_SearchCollectionTypes
-Filters_TextLocale <String[]>
Filters by the locale of the content or comment.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_TextLocales
-Limit <Int32>
Max results count per page.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Marker <String>
The marker for the next set of results.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'Marker' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-Marker' to null for the first call then set the 'Marker' using the same property output from the previous call for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNextToken
-ModifiedRange_EndValue <DateTime>
Timestamp range end value (in epochs).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_ModifiedRange_EndValue
-ModifiedRange_StartValue <DateTime>
Timestamp range start value (in epochs)
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_ModifiedRange_StartValue
-NoAutoIteration <SwitchParameter>
By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of Marker as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OrderBy <SearchSortResult[]>
Order by results in one or more categories.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OrganizationId <String>
Filters based on the resource owner OrgId. This is a mandatory parameter when using Admin SigV4 credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-QueryScope <String[]>
Filter based on the text field type. A Folder has only a name and no content. A Comment has only content and no name. A Document or Document Version has a name and content
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesQueryScopes
-QueryText <String>
The String to search for. Searches across different text fields based on request parameters. Use double quotes around the query string for exact phrase matches.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'Items'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.WorkDocs.Model.SearchResourcesResponse). Specifying the name of a property of type Amazon.WorkDocs.Model.SearchResourcesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SizeRange_EndValue <Int64>
The size end range (in bytes).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_SizeRange_EndValue
-SizeRange_StartValue <Int64>
The size start range (in bytes).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFilters_SizeRange_StartValue

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.WorkDocs.Model.ResponseItem or Amazon.WorkDocs.Model.SearchResourcesResponse
This cmdlet returns a collection of Amazon.WorkDocs.Model.ResponseItem objects. The service call response (type Amazon.WorkDocs.Model.SearchResourcesResponse) can be returned by specifying '-Select *'.
Administrator Guide
Developer Guide
Service API Reference
User Guide
AWS Tools for PowerShell User Guide

Supported Version

AWS Tools for PowerShell: 2.x.y.z