AWS.Tools.ConnectContactLens.XML

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>AWS.Tools.ConnectContactLens</name>
    </assembly>
    <members>
        <member name="T:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet">
            <summary>
            Provides a list of analysis segments for a real-time analysis session.<br/><br/>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.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.ContactId">
            <summary>
            <para>
            <para>The identifier of the contact.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.InstanceId">
            <summary>
            <para>
            <para>The identifier of the Amazon Connect instance.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.MaxResult">
            <summary>
            <para>
            <para>The maximimum number of results to return per page.</para>
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.NextToken">
            <summary>
            <para>
            <para>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.</para>
            </para>
            <para>
            <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call.
            <br/>In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls.
            </para>
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.Select">
            <summary>
            Use the -Select parameter to control the cmdlet output. The default value is 'Segments'.
            Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectContactLens.Model.ListRealtimeContactAnalysisSegmentsResponse).
            Specifying the name of a property of type Amazon.ConnectContactLens.Model.ListRealtimeContactAnalysisSegmentsResponse will result in that property being returned.
            Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.PassThru">
            <summary>
            Changes the cmdlet behavior to return the value passed to the ContactId parameter.
            The -PassThru parameter is deprecated, use -Select '^ContactId' instead. This parameter will be removed in a future version.
            </summary>
        </member>
        <member name="P:Amazon.PowerShell.Cmdlets.CCL.GetCCLRealtimeContactAnalysisSegmentListCmdlet.NoAutoIteration">
            <summary>
            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.
            </summary>
        </member>
    </members>
</doc>