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 Connect Service SearchContacts API operation.

Syntax

Search-CONNContact
-InstanceId <String>
-SearchCriteria_ActiveRegion <String[]>
-SearchCriteria_AgentId <String[]>
-SearchCriteria_ContactTags_AndCondition <TagCondition[]>
-SearchCriteria_Channel <String[]>
-AdditionalTimeRange_Criterion <SearchContactsAdditionalTimeRangeCriteria[]>
-Transcript_Criterion <TranscriptCriteria[]>
-SearchableContactAttributes_Criterion <SearchableContactAttributesCriteria[]>
-SearchableSegmentAttributes_Criterion <SearchableSegmentAttributesCriteria[]>
-TimeRange_EndTime <DateTime>
-Sort_FieldName <SortableFieldName>
-SearchCriteria_InitiationMethod <String[]>
-AgentHierarchyGroups_L1Id <String[]>
-AgentHierarchyGroups_L2Id <String[]>
-AgentHierarchyGroups_L3Id <String[]>
-AgentHierarchyGroups_L4Id <String[]>
-AgentHierarchyGroups_L5Id <String[]>
-AdditionalTimeRange_MatchType <SearchContactsMatchType>
-Transcript_MatchType <SearchContactsMatchType>
-Name_MatchType <SearchContactsMatchType>
-SearchableContactAttributes_MatchType <SearchContactsMatchType>
-SearchableSegmentAttributes_MatchType <SearchContactsMatchType>
-SearchCriteria_ContactTags_OrCondition <TagCondition[][]>
-Sort_Order <SortOrder>
-SearchCriteria_QueueId <String[]>
-Name_SearchText <String[]>
-TimeRange_StartTime <DateTime>
-RoutingCriteria_Step <SearchableRoutingCriteriaStep[]>
-SearchCriteria_ContactTags_TagCondition_TagKey <String>
-SearchCriteria_ContactTags_TagCondition_TagValue <String>
-TimeRange_Type <SearchContactsTimeRangeType>
-MaxResult <Int32>
-NextToken <String>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-NoAutoIteration <SwitchParameter>
-ClientConfig <AmazonConnectConfig>

Description

Searches contacts in an Amazon Connect instance.

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

-AdditionalTimeRange_Criterion <SearchContactsAdditionalTimeRangeCriteria[]>
List of criteria of the time range to additionally filter on.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AdditionalTimeRange_Criteria
-AdditionalTimeRange_MatchType <SearchContactsMatchType>
The match type combining multiple time range filters.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AdditionalTimeRange_MatchType
-AgentHierarchyGroups_L1Id <String[]>
The identifiers for level 1 hierarchy groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AgentHierarchyGroups_L1Ids
-AgentHierarchyGroups_L2Id <String[]>
The identifiers for level 2 hierarchy groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AgentHierarchyGroups_L2Ids
-AgentHierarchyGroups_L3Id <String[]>
The identifiers for level 3 hierarchy groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AgentHierarchyGroups_L3Ids
-AgentHierarchyGroups_L4Id <String[]>
The identifiers for level 4 hierarchy groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AgentHierarchyGroups_L4Ids
-AgentHierarchyGroups_L5Id <String[]>
The identifiers for level 5 hierarchy groups.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AgentHierarchyGroups_L5Ids
-ClientConfig <AmazonConnectConfig>
Amazon.PowerShell.Cmdlets.CONN.AmazonConnectClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-InstanceId <String>
The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-MaxResult <Int32>
The maximum number of results to return per page.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesMaxResults
-Name_MatchType <SearchContactsMatchType>
The match type combining name search criteria using multiple search texts in a name criteria.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_Name_MatchType
-Name_SearchText <String[]>
The words or phrases used to match the contact name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_Name_SearchText
-NextToken <String>
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
'NextToken' is only returned by the cmdlet when '-Select *' is specified. In order to manually control output pagination, set '-NextToken' to null for the first call then set the 'NextToken' using the same property output from the previous call for subsequent calls.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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 NextToken as the start point.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the InstanceId parameter. The -PassThru parameter is deprecated, use -Select '^InstanceId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RoutingCriteria_Step <SearchableRoutingCriteriaStep[]>
The list of Routing criteria steps of the contact routing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_RoutingCriteria_Steps
-SearchableContactAttributes_Criterion <SearchableContactAttributesCriteria[]>
The list of criteria based on user-defined contact attributes that are configured for contact search.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_SearchableContactAttributes_Criteria
-SearchableContactAttributes_MatchType <SearchContactsMatchType>
The match type combining search criteria using multiple searchable contact attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_SearchableContactAttributes_MatchType
-SearchableSegmentAttributes_Criterion <SearchableSegmentAttributesCriteria[]>
The list of criteria based on searchable segment attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_SearchableSegmentAttributes_Criteria
-SearchableSegmentAttributes_MatchType <SearchContactsMatchType>
The match type combining search criteria using multiple searchable segment attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_SearchableSegmentAttributes_MatchType
-SearchCriteria_ActiveRegion <String[]>
The list of active regions for contacts in ACGR instances.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_ActiveRegions
-SearchCriteria_AgentId <String[]>
The identifiers of agents who handled the contacts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_AgentIds
-SearchCriteria_Channel <String[]>
The list of channels associated with contacts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_Channels
-SearchCriteria_ContactTags_AndCondition <TagCondition[]>
A list of conditions which would be applied together with an AND condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_ContactTags_AndConditions
-SearchCriteria_ContactTags_OrCondition <TagCondition[][]>
A list of conditions which would be applied together with an OR condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_ContactTags_OrConditions
-SearchCriteria_ContactTags_TagCondition_TagKey <String>
The tag key in the tag condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SearchCriteria_ContactTags_TagCondition_TagValue <String>
The tag value in the tag condition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SearchCriteria_InitiationMethod <String[]>
The list of initiation methods associated with contacts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_InitiationMethods
-SearchCriteria_QueueId <String[]>
The list of queue IDs associated with contacts.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_QueueIds
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.SearchContactsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchContactsResponse 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)
-Sort_FieldName <SortableFieldName>
The name of the field on which to sort.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Sort_Order <SortOrder>
An ascending or descending sort.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeRange_EndTime <DateTime>
The end time of the time range.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeRange_StartTime <DateTime>
The start time of the time range.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeRange_Type <SearchContactsTimeRangeType>
The type of timestamp to search.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Transcript_Criterion <TranscriptCriteria[]>
The list of search criteria based on Contact Lens conversational analytics transcript.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_ContactAnalysis_Transcript_Criteria
-Transcript_MatchType <SearchContactsMatchType>
The match type combining search criteria using multiple transcript criteria.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSearchCriteria_ContactAnalysis_Transcript_MatchType

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.Connect.Model.SearchContactsResponse
This cmdlet returns an Amazon.Connect.Model.SearchContactsResponse object containing multiple properties.
Administrator Guide
User Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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