AWS.Tools.Connect.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Connect</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet"> <summary> Retrieves the contact attributes associated with a contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet.InitialContactId"> <summary> <para> <para>The ID for the initial contact in Amazon Connect associated with the attributes to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet.InstanceId"> <summary> <para> <para>The instance ID for the instance from which to retrieve contact attributes.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet"> <summary> The <code>GetCurrentMetricData</code> operation retrieves current metric data from your Amazon Connect instance. <para> If you are using an IAM account, it must have permission to the <code>connect:GetCurrentMetricData</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Filters_Channel"> <summary> <para> <para>The Channel to use as a filter for the metrics returned. Only VOICE is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.CurrentMetric"> <summary> <para> <para>A list of <code>CurrentMetric</code> objects for the metrics to retrieve. Each <code>CurrentMetric</code> includes a name of a metric to retrieve and the unit to use for it. You must list each metric to retrieve data for in the request.</para><para>The following metrics are available:</para><dl><dt>AGENTS_AVAILABLE</dt><dd><para>Unit: COUNT</para></dd><dt>AGENTS_ONLINE</dt><dd><para>Unit: COUNT</para></dd><dt>AGENTS_ON_CALL</dt><dd><para>Unit: COUNT</para></dd><dt>AGENTS_STAFFED</dt><dd><para>Unit: COUNT</para></dd><dt>AGENTS_AFTER_CONTACT_WORK</dt><dd><para>Unit: COUNT</para></dd><dt>AGENTS_NON_PRODUCTIVE</dt><dd><para>Unit: COUNT</para></dd><dt>AGENTS_ERROR</dt><dd><para>Unit: COUNT</para></dd><dt>CONTACTS_IN_QUEUE</dt><dd><para>Unit: COUNT</para></dd><dt>OLDEST_CONTACT_AGE</dt><dd><para>Unit: SECONDS</para></dd><dt>CONTACTS_SCHEDULED</dt><dd><para>Unit: COUNT</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Grouping"> <summary> <para> <para>The grouping applied to the metrics returned. For example, when grouped by QUEUE, the metrics returned apply to each queue rather than aggregated for all queues. If you group by CHANNEL, you should include a Channels filter. The only supported channel is VOICE.</para><para>If no <code>Grouping</code> is included in the request, a summary of <code>CurrentMetrics</code> is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Filters_Queue"> <summary> <para> <para>A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.MaxResult"> <summary> <para> <para><code>MaxResults</code> indicates the maximum number of results to return per page in the response, between 1 and 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.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>The token expires after 5 minutes from the time it is created. Subsequent requests that use the <a href="">NextToken</a> must use the same request parameters as the request that generated the token.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNFederationTokenCmdlet"> <summary> Retrieves a token for federation. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFederationTokenCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet"> <summary> The <code>GetMetricData</code> operation retrieves historical metrics data from your Amazon Connect instance. <para> If you are using an IAM account, it must have permission to the <code>connect:GetMetricData</code> action. </para><br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Filters_Channel"> <summary> <para> <para>The Channel to use as a filter for the metrics returned. Only VOICE is supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.EndTime"> <summary> <para> <para>The timestamp, in UNIX Epoch time format, at which to end the reporting interval for the retrieval of historical metrics data. The time must be specified using an interval of 5 minutes, such as 11:00, 11:05, 11:10, and must be later than the <code>StartTime</code> timestamp.</para><para>The time range between <code>StartTime</code> and <code>EndTime</code> must be less than 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Grouping"> <summary> <para> <para>The grouping applied to the metrics returned. For example, when results are grouped by queueId, the metrics returned are grouped by queue. The values returned apply to the metrics for each queue rather than aggregated for all queues.</para><para>The current version supports grouping by Queue</para><para>If no <code>Grouping</code> is included in the request, a summary of <code>HistoricalMetrics</code> for all queues is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.HistoricalMetric"> <summary> <para> <para>A list of <code>HistoricalMetric</code> objects that contain the metrics to retrieve with the request.</para><para>A <code>HistoricalMetric</code> object contains: <code>HistoricalMetricName</code>, <code>Statistic</code>, <code>Threshold</code>, and <code>Unit</code>.</para><para>You must list each metric to retrieve data for in the request. For each historical metric you include in the request, you must include a <code>Unit</code> and a <code>Statistic</code>. </para><para>The following historical metrics are available:</para><dl><dt>CONTACTS_QUEUED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_ABANDONED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_CONSULTED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_HANDLED_INCOMING</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_HANDLED_OUTBOUND</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_HOLD_ABANDONS</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_TRANSFERRED_IN</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_TRANSFERRED_OUT</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CALLBACK_CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CALLBACK_CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>API_CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>CONTACTS_MISSED</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>OCCUPANCY</dt><dd><para>Unit: PERCENT</para><para>Statistics: AVG</para></dd><dt>HANDLE_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: AVG</para></dd><dt>AFTER_CONTACT_WORK_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: AVG</para></dd><dt>QUEUED_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: MAX</para></dd><dt>ABANDON_TIME</dt><dd><para>Unit: COUNT</para><para>Statistics: SUM</para></dd><dt>QUEUE_ANSWER_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: AVG</para></dd><dt>HOLD_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: AVG</para></dd><dt>INTERACTION_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: AVG</para></dd><dt>INTERACTION_AND_HOLD_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistics: AVG</para></dd><dt>SERVICE_LEVEL</dt><dd><para>Unit: PERCENT</para><para>Statistics: AVG</para><para>Threshold: Only "Less than" comparisons are supported, with the following service level thresholds: 15, 20, 25, 30, 45, 60, 90, 120, 180, 240, 300, 600</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Filters_Queue"> <summary> <para> <para>A list of up to 100 queue IDs or queue ARNs to use to filter the metrics retrieved. You can include both IDs and ARNs in a request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.StartTime"> <summary> <para> <para>The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the retrieval of historical metrics data. The time must be specified using a multiple of 5 minutes, such as 10:05, 10:10, 10:15.</para><para><code>StartTime</code> cannot be earlier than 24 hours before the time of the request. Historical metrics are available in Amazon Connect only for 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.MaxResult"> <summary> <para> <para>Indicates the maximum number of results to return per page in the response, between 1-100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet"> <summary> Returns an array of <code>RoutingProfileSummary</code> objects that includes information about the routing profiles in your instance.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of routing profiles to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet.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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet"> <summary> Returns an array of SecurityProfileSummary objects that contain information about the security profiles in your instance, including the ARN, Id, and Name of the security profile.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of security profiles to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet.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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet"> <summary> Returns a <code>User</code> object that contains information about the user account specified by the <code>UserId</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet.UserId"> <summary> <para> <para>Unique identifier for the user account to return.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet"> <summary> Returns a <code>HierarchyGroup</code> object that includes information about a hierarchy group in your instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier for the hierarchy group to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet"> <summary> Returns a <code>UserHierarchyGroupSummaryList</code>, which is an array of <code>HierarchyGroupSummary</code> objects that contain information about the hierarchy groups in your instance.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of hierarchy groups to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet.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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyStructureCmdlet"> <summary> Returns a <code>HiearchyGroupStructure</code> object, which contains data about the levels in the agent hierarchy. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyStructureCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet"> <summary> Returns a <code>UserSummaryList</code>, which is an array of <code>UserSummary</code> objects.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return in the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet.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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet"> <summary> Creates a new user account in your Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.DirectoryUserId"> <summary> <para> <para>The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the <code>DirectoryUserId</code> to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the <code>UserIdentityInfo</code> is used to authenticate users from your existing directory.</para><para>This parameter is required if you are using an existing directory for identity management in Amazon Connect when Amazon Connect cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an <code>InvalidRequestException</code> is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.HierarchyGroupId"> <summary> <para> <para>The unique identifier for the hierarchy group to assign to the user created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.IdentityInfo"> <summary> <para> <para>Information about the user, including email address, first name, and last name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Password"> <summary> <para> <para>The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an <code>InvalidRequestException</code> is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.PhoneConfig"> <summary> <para> <para>Specifies the phone settings for the user, including <code>AfterContactWorkTimeLimit</code>, <code>AutoAccept</code>, <code>DeskPhoneNumber</code>, and <code>PhoneType</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.RoutingProfileId"> <summary> <para> <para>The unique identifier for the routing profile to assign to the user created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.SecurityProfileId"> <summary> <para> <para>The unique identifier of the security profile to assign to the user created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Username"> <summary> <para> <para>The user name in Amazon Connect for the account to create. If you are using SAML for identity management in your Amazon Connect, the value for <code>Username</code> can include up to 64 characters from [a-zA-Z0-9_-.\@]+.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet"> <summary> Deletes a user account from Amazon Connect. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.UserId"> <summary> <para> <para>The unique identifier of the user to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet"> <summary> The <code>StartOutboundVoiceContact</code> operation initiates a contact flow to place an outbound call to a customer. <para> If you are using an IAM account, it must have permission to the <code>connect:StartOutboundVoiceContact</code> action. </para><para> There is a 60 second dialing timeout for this operation. If the call is not connected after 60 seconds, the call fails. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Attribute"> <summary> <para> <para>Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</para><para>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</para><para>For example, if you want play a greeting when the customer answers the call, you can pass the customer name in attributes similar to the following:</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. If the contact is disconnected, a new contact is started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier for the contact flow to connect the outbound call to.</para><para>To find the <code>ContactFlowId</code>, open the contact flow you want to use in the Amazon Connect contact flow editor. The ID for the contact flow is displayed in the address bar as part of the URL. For example, the contact flow ID is the set of characters at the end of the URL, after 'contact-flow/' such as <code>78ea8fd5-2659-4f2b-b528-699760ccfc1b</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.DestinationPhoneNumber"> <summary> <para> <para>The phone number of the customer in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.QueueId"> <summary> <para> <para>The queue to add the call to. If you specify a queue, the phone displayed for caller ID is the phone number specified in the queue. If you do not specify a queue, the queue used will be the queue defined in the contact flow.</para><para>To find the <code>QueueId</code>, open the queue you want to use in the Amazon Connect Queue editor. The ID for the queue is displayed in the address bar as part of the URL. For example, the queue ID is the set of characters at the end of the URL, after 'queue/' such as <code>queue/aeg40574-2d01-51c3-73d6-bf8624d2168c</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.SourcePhoneNumber"> <summary> <para> <para>The phone number, in E.164 format, associated with your Amazon Connect instance to use for the outbound call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet"> <summary> Ends the contact initiated by the <code>StartOutboundVoiceContact</code> operation. <para> If you are using an IAM account, it must have permission to the <code>connect:StopContact</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.ContactId"> <summary> <para> <para>The unique identifier of the contact to end.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.PassThru"> <summary> Returns the value passed to the ContactId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet"> <summary> The <code>UpdateContactAttributes</code> operation lets you programmatically create new, or update existing, contact attributes associated with a contact. You can use the operation to add or update attributes for both ongoing and completed contacts. For example, you can update the customer's name or the reason the customer called while the call is active, or add notes about steps that the agent took during the call that are displayed to the next agent that takes the call. You can also use the <code>UpdateContactAttributes</code> operation to update attributes for a contact using data from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls for additional analysis, such as legal review or identifying abusive callers. <para> Contact attributes are available in Amazon Connect for 24 months, and are then deleted. </para><para><i>Important:</i></para><para> You cannot use the operation to update attributes for contacts that occurred prior to the release of the API, September 12, 2018. You can update attributes only for contacts that started after the release of the API. If you attempt to update attributes for a contact that occurred prior to the release of the API, a 400 error is returned. This applies also to queued callbacks that were initiated prior to the release of the API but are still active in your instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.Attribute"> <summary> <para> <para>Specify a custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact flows just like any other contact attributes.</para><para>There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.InitialContactId"> <summary> <para> <para>The unique identifier of the contact for which to update attributes. This is the identifier for the contact associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.PassThru"> <summary> Returns the value passed to the InitialContactId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet"> <summary> Assigns the specified hierarchy group to the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier for the hierarchy group to assign to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.UserId"> <summary> <para> <para>The identifier of the user account to assign the hierarchy group to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet"> <summary> Updates the identity information for the specified user in a <code>UserIdentityInfo</code> object, including email, first name, and last name. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.IdentityInfo"> <summary> <para> <para>A <code>UserIdentityInfo</code> object.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.UserId"> <summary> <para> <para>The identifier for the user account to update identity information for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet"> <summary> Updates the phone configuration settings in the <code>UserPhoneConfig</code> object for the specified user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.PhoneConfig"> <summary> <para> <para>A <code>UserPhoneConfig</code> object that contains settings for <code>AfterContactWorkTimeLimit</code>, <code>AutoAccept</code>, <code>DeskPhoneNumber</code>, and <code>PhoneType</code> to assign to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.UserId"> <summary> <para> <para>The identifier for the user account to change phone settings for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet"> <summary> Assigns the specified routing profile to a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile to assign to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.UserId"> <summary> <para> <para>The identifier for the user account to assign the routing profile to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.PassThru"> <summary> Returns the value passed to the RoutingProfileId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet"> <summary> Updates the security profiles assigned to the user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.SecurityProfileId"> <summary> <para> <para>The identifiers for the security profiles to assign to the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.UserId"> <summary> <para> <para>The identifier of the user account to assign the security profiles.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.PassThru"> <summary> Returns the value passed to the UserId parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |