AWS.Tools.Connect.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Connect</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CONN.AddCONNApprovedOriginCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Associates an approved origin to an Amazon Connect instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNApprovedOriginCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNApprovedOriginCmdlet.Origin"> <summary> <para> <para>The domain to add to your allow list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNApprovedOriginCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateApprovedOriginResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNApprovedOriginCmdlet.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.AddCONNBotCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Allows the specified Amazon Connect instance to access the specified Amazon Lex or Amazon Lex V2 bot. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.LexV2Bot_AliasArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.LexBot_LexRegion"> <summary> <para> <para>The Amazon Web Services Region where the Amazon Lex bot was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.LexBot_Name"> <summary> <para> <para>The name of the Amazon Lex bot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateBotResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNBotCmdlet.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.AddCONNContactTagCmdlet"> <summary> Adds the specified tags to the contact resource. For more information about this API is used, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html">Set up granular billing for a detailed view of your Amazon Connect usage</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNContactTagCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNContactTagCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNContactTagCmdlet.Tag"> <summary> <para> <para>The tags to be assigned to the contact resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para><note><para>Authorization is not supported by this tag.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNContactTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.TagContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNContactTagCmdlet.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.CONN.AddCONNContactTagCmdlet.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.AddCONNDefaultVocabularyCmdlet"> <summary> Associates an existing vocabulary as the default. Contact Lens for Amazon Connect uses the vocabulary in post-call and real-time analysis sessions for the given language. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNDefaultVocabularyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNDefaultVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNDefaultVocabularyCmdlet.VocabularyId"> <summary> <para> <para>The identifier of the custom vocabulary. If this is empty, the default is set to none.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNDefaultVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateDefaultVocabularyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNDefaultVocabularyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNDefaultVocabularyCmdlet.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.AddCONNFlowCmdlet"> <summary> Associates a connect resource to a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.FlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.ResourceId"> <summary> <para> <para>The identifier of the resource.</para><ul><li><para>Amazon Web Services End User Messaging SMS phone number ARN when using <c>SMS_PHONE_NUMBER</c></para></li><li><para>Amazon Web Services End User Messaging Social phone number ARN when using <c>WHATSAPP_MESSAGING_PHONE_NUMBER</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNFlowCmdlet.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.AddCONNInstanceStorageConfigCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Associates a storage resource type for the first time. You can only associate one type of storage configuration in a single call. This means, for example, that you can't define an instance with multiple S3 buckets for storing chat transcripts. </para><para> This API does not create a resource that doesn't exist. It only associates it to the instance. Ensure that the resource being specified in the storage configuration, like an S3 bucket, exists when being used for association. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.StorageConfig_AssociationId"> <summary> <para> <para>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.S3Config_BucketName"> <summary> <para> <para>The S3 bucket name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.S3Config_BucketPrefix"> <summary> <para> <para>The S3 bucket prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.StorageConfigKinesisVideoStreamConfigEncryptionConfigEncryptionType"> <summary> <para> <para>The type of encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.StorageConfigS3ConfigEncryptionConfigEncryptionType"> <summary> <para> <para>The type of encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.KinesisFirehoseConfig_FirehoseArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.StorageConfigKinesisVideoStreamConfigEncryptionConfigKeyId"> <summary> <para> <para>The full ARN of the encryption key. </para><note><para>Be sure to provide the full ARN of the encryption key, not just the ID.</para><para>Amazon Connect supports only KMS keys with the default key spec of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default"><c>SYMMETRIC_DEFAULT</c></a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.StorageConfigS3ConfigEncryptionConfigKeyId"> <summary> <para> <para>The full ARN of the encryption key. </para><note><para>Be sure to provide the full ARN of the encryption key, not just the ID.</para><para>Amazon Connect supports only KMS keys with the default key spec of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default"><c>SYMMETRIC_DEFAULT</c></a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.KinesisVideoStreamConfig_Prefix"> <summary> <para> <para>The prefix of the video stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.ResourceType"> <summary> <para> <para>A valid resource type. To <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-contact-analysis-segment-streams.html">enable streaming for real-time analysis of contacts</a>, use the following types:</para><ul><li><para>For chat contacts, use <c>REAL_TIME_CONTACT_ANALYSIS_CHAT_SEGMENTS</c>.</para></li><li><para>For voice contacts, use <c>REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS</c>.</para></li></ul><note><para><c>REAL_TIME_CONTACT_ANALYSIS_SEGMENTS</c> is deprecated, but it is still supported and will apply only to VOICE channel contacts. Use <c>REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS</c> for voice contacts moving forward.</para><para>If you have previously associated a stream with <c>REAL_TIME_CONTACT_ANALYSIS_SEGMENTS</c>, no action is needed to update the stream to <c>REAL_TIME_CONTACT_ANALYSIS_VOICE_SEGMENTS</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.KinesisVideoStreamConfig_RetentionPeriodHour"> <summary> <para> <para>The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</para><para>The default value is 0, indicating that the stream does not persist data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.StorageConfig_StorageType"> <summary> <para> <para>A valid storage type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.KinesisStreamConfig_StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the data stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNInstanceStorageConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateInstanceStorageConfigResponse). Specifying the name of a property of type Amazon.Connect.Model.AssociateInstanceStorageConfigResponse 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.CONN.AddCONNInstanceStorageConfigCmdlet.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.AddCONNLambdaFunctionCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Allows the specified Amazon Connect instance to access the specified Lambda function. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLambdaFunctionCmdlet.FunctionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for the Lambda function being associated. Maximum number of characters allowed is 140.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLambdaFunctionCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLambdaFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateLambdaFunctionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLambdaFunctionCmdlet.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.AddCONNLexBotCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Allows the specified Amazon Connect instance to access the specified Amazon Lex V1 bot. This API only supports the association of Amazon Lex V1 bots. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLexBotCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLexBotCmdlet.LexBot_LexRegion"> <summary> <para> <para>The Amazon Web Services Region where the Amazon Lex bot was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLexBotCmdlet.LexBot_Name"> <summary> <para> <para>The name of the Amazon Lex bot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLexBotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateLexBotResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLexBotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNLexBotCmdlet.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.AddCONNPhoneNumberContactFlowCmdlet"> <summary> Associates a flow with a phone number claimed to your Amazon Connect instance. <important><para> If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the <c>PhoneNumberId</c> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <c>ResourceNotFoundException</c>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNPhoneNumberContactFlowCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNPhoneNumberContactFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNPhoneNumberContactFlowCmdlet.PhoneNumberId"> <summary> <para> <para>A unique identifier for the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNPhoneNumberContactFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociatePhoneNumberContactFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNPhoneNumberContactFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNPhoneNumberContactFlowCmdlet.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.AddCONNQueueQuickConnectCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Associates a set of quick connects with a queue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNQueueQuickConnectCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNQueueQuickConnectCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNQueueQuickConnectCmdlet.QuickConnectId"> <summary> <para> <para>The quick connects to associate with this queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNQueueQuickConnectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateQueueQuickConnectsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNQueueQuickConnectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNQueueQuickConnectCmdlet.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.AddCONNResourceTagCmdlet"> <summary> Adds the specified tags to the specified resource. <para> Some of the supported resource types are agents, routing profiles, queues, quick connects, flows, agent statuses, hours of operation, phone numbers, security profiles, and task templates. For a complete list, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tagging.html">Tagging resources in Amazon Connect</a>. </para><para> For sample policies that use tags, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNResourceTagCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNResourceTagCmdlet.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.AddCONNSecurityKeyCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Associates a security key to the instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNSecurityKeyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNSecurityKeyCmdlet.Key"> <summary> <para> <para>A valid security key in PEM format as a String.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNSecurityKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AssociationId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateSecurityKeyResponse). Specifying the name of a property of type Amazon.Connect.Model.AssociateSecurityKeyResponse 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.CONN.AddCONNSecurityKeyCmdlet.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.AddCONNTrafficDistributionGroupUserCmdlet"> <summary> Associates an agent with a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNTrafficDistributionGroupUserCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNTrafficDistributionGroupUserCmdlet.TrafficDistributionGroupId"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNTrafficDistributionGroupUserCmdlet.UserId"> <summary> <para> <para>The identifier of the user account. This can be the ID or the ARN of the user. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNTrafficDistributionGroupUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateTrafficDistributionGroupUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNTrafficDistributionGroupUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrafficDistributionGroupId parameter. The -PassThru parameter is deprecated, use -Select '^TrafficDistributionGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNTrafficDistributionGroupUserCmdlet.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.AddCONNUserProficiencyCmdlet"> <summary> >Associates a set of proficiencies with a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNUserProficiencyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN of the instance).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNUserProficiencyCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNUserProficiencyCmdlet.UserProficiency"> <summary> <para> <para>The proficiencies to associate with the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNUserProficiencyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateUserProficienciesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNUserProficiencyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.AddCONNUserProficiencyCmdlet.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.CompleteCONNAttachedFileUploadCmdlet"> <summary> Allows you to confirm that the attached file has been uploaded using the pre-signed URL provided in the StartAttachedFileUpload API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CompleteCONNAttachedFileUploadCmdlet.AssociatedResourceArn"> <summary> <para> <para>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</para><note><para>This value must be a valid ARN.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CompleteCONNAttachedFileUploadCmdlet.FileId"> <summary> <para> <para>The unique identifier of the attached file resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CompleteCONNAttachedFileUploadCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CompleteCONNAttachedFileUploadCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.CompleteAttachedFileUploadResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CompleteCONNAttachedFileUploadCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociatedResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^AssociatedResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CompleteCONNAttachedFileUploadCmdlet.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.CopyCONNInstanceCmdlet"> <summary> Replicates an Amazon Connect instance in the specified Amazon Web Services Region and copies configuration information for Amazon Connect resources across Amazon Web Services Regions. <para> For more information about replicating an Amazon Connect instance, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-replica-connect-instance.html">Create a replica of your existing Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CopyCONNInstanceCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You can provide the <c>InstanceId</c>, or the entire ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CopyCONNInstanceCmdlet.ReplicaAlias"> <summary> <para> <para>The alias for the replicated instance. The <c>ReplicaAlias</c> must be unique.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CopyCONNInstanceCmdlet.ReplicaRegion"> <summary> <para> <para>The Amazon Web Services Region where to replicate the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CopyCONNInstanceCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CopyCONNInstanceCmdlet.Select"> <summary> 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.ReplicateInstanceResponse). Specifying the name of a property of type Amazon.Connect.Model.ReplicateInstanceResponse 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.CONN.CopyCONNInstanceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.CopyCONNInstanceCmdlet.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.DisableCONNEvaluationFormCmdlet"> <summary> Deactivates an evaluation form in the specified Amazon Connect instance. After a form is deactivated, it is no longer available for users to start new evaluations based on the form. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisableCONNEvaluationFormCmdlet.EvaluationFormId"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisableCONNEvaluationFormCmdlet.EvaluationFormVersion"> <summary> <para> <para>A version of the evaluation form. If the version property is not provided, the latest version of the evaluation form is deactivated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisableCONNEvaluationFormCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisableCONNEvaluationFormCmdlet.Select"> <summary> 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.DeactivateEvaluationFormResponse). Specifying the name of a property of type Amazon.Connect.Model.DeactivateEvaluationFormResponse 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.CONN.DisableCONNEvaluationFormCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisableCONNEvaluationFormCmdlet.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.DisconnectCONNRoutingProfileQueueCmdlet"> <summary> Disassociates a set of queues from a routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisconnectCONNRoutingProfileQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisconnectCONNRoutingProfileQueueCmdlet.QueueReference"> <summary> <para> <para>The queues to disassociate from this routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisconnectCONNRoutingProfileQueueCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisconnectCONNRoutingProfileQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateRoutingProfileQueuesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisconnectCONNRoutingProfileQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.DisconnectCONNRoutingProfileQueueCmdlet.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.EnableCONNEvaluationFormCmdlet"> <summary> Activates an evaluation form in the specified Amazon Connect instance. After the evaluation form is activated, it is available to start new evaluations based on the form. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.EnableCONNEvaluationFormCmdlet.EvaluationFormId"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.EnableCONNEvaluationFormCmdlet.EvaluationFormVersion"> <summary> <para> <para>The version of the evaluation form to activate. If the version property is not provided, the latest version of the evaluation form is activated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.EnableCONNEvaluationFormCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.EnableCONNEvaluationFormCmdlet.Select"> <summary> 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.ActivateEvaluationFormResponse). Specifying the name of a property of type Amazon.Connect.Model.ActivateEvaluationFormResponse 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.CONN.EnableCONNEvaluationFormCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.EnableCONNEvaluationFormCmdlet.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.GetCONNAgentStatusCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Describes an agent status. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusCmdlet.AgentStatusId"> <summary> <para> <para>The identifier for the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentStatus'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeAgentStatusResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeAgentStatusResponse 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.CONN.GetCONNAgentStatusCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Lists agent statuses. </para><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.CONN.GetCONNAgentStatusListCmdlet.AgentStatusType"> <summary> <para> <para>Available agent status types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AgentStatusSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListAgentStatusesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListAgentStatusesResponse 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.CONN.GetCONNAgentStatusListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAgentStatusListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNAnalyticsDataAssociationListCmdlet"> <summary> Lists the association status of requested dataset ID for a given Amazon Connect instance.<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.CONN.GetCONNAnalyticsDataAssociationListCmdlet.DataSetId"> <summary> <para> <para>The identifier of the dataset to get the association status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAnalyticsDataAssociationListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAnalyticsDataAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAnalyticsDataAssociationListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAnalyticsDataAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Results'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListAnalyticsDataAssociationsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListAnalyticsDataAssociationsResponse 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.CONN.GetCONNAnalyticsDataAssociationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAnalyticsDataAssociationListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNApprovedOriginListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns a paginated list of all approved origins associated with the instance. </para><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.CONN.GetCONNApprovedOriginListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNApprovedOriginListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNApprovedOriginListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNApprovedOriginListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Origins'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListApprovedOriginsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListApprovedOriginsResponse 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.CONN.GetCONNApprovedOriginListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNApprovedOriginListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNAssociatedContactListCmdlet"> <summary> Provides information about contact tree, a list of associated contacts with a unique identifier.<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.CONN.GetCONNAssociatedContactListCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAssociatedContactListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAssociatedContactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para><para>The maximum number of results to return per page. The default MaxResult size is 25.</para><para>Valid Range: Minimum value of 1. Maximum value of 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAssociatedContactListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAssociatedContactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListAssociatedContactsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListAssociatedContactsResponse 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.CONN.GetCONNAssociatedContactListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAssociatedContactListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNAttachedFileCmdlet"> <summary> Provides a pre-signed URL for download of an approved attached file. This API also returns metadata about the attached file. It will only return a downloadURL if the status of the attached file is <c>APPROVED</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAttachedFileCmdlet.AssociatedResourceArn"> <summary> <para> <para>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</para><note><para>This value must be a valid ARN.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAttachedFileCmdlet.FileId"> <summary> <para> <para>The unique identifier of the attached file resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAttachedFileCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAttachedFileCmdlet.UrlExpiryInSecond"> <summary> <para> <para>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAttachedFileCmdlet.Select"> <summary> 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.GetAttachedFileResponse). Specifying the name of a property of type Amazon.Connect.Model.GetAttachedFileResponse 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.CONN.GetCONNAttachedFileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociatedResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^AssociatedResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. <para> Describes the target authentication profile. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileCmdlet.AuthenticationProfileId"> <summary> <para> <para>A unique identifier for the authentication profile. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AuthenticationProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeAuthenticationProfileResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeAuthenticationProfileResponse 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.CONN.GetCONNAuthenticationProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AuthenticationProfileId parameter. The -PassThru parameter is deprecated, use -Select '^AuthenticationProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. <para> Provides summary information about the authentication profiles in a specified Amazon Connect instance. </para><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.CONN.GetCONNAuthenticationProfileListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AuthenticationProfileSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListAuthenticationProfilesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListAuthenticationProfilesResponse 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.CONN.GetCONNAuthenticationProfileListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNAuthenticationProfileListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNBatchAttachedFileMetadataCmdlet"> <summary> Allows you to retrieve metadata about multiple attached files on an associated resource. Each attached file provided in the input list must be associated with the input AssociatedResourceArn. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBatchAttachedFileMetadataCmdlet.AssociatedResourceArn"> <summary> <para> <para>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</para><note><para>This value must be a valid ARN.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBatchAttachedFileMetadataCmdlet.FileId"> <summary> <para> <para>The unique identifiers of the attached file resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBatchAttachedFileMetadataCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBatchAttachedFileMetadataCmdlet.Select"> <summary> 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.BatchGetAttachedFileMetadataResponse). Specifying the name of a property of type Amazon.Connect.Model.BatchGetAttachedFileMetadataResponse 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.CONN.GetCONNBatchAttachedFileMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociatedResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^AssociatedResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNBotListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> For the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently associated with the instance. Use this API to returns both Amazon Lex V1 and V2 bots. </para><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.CONN.GetCONNBotListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBotListCmdlet.LexVersion"> <summary> <para> <para>The version of Amazon Lex or Amazon Lex V2.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBotListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBotListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBotListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LexBots'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListBotsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListBotsResponse 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.CONN.GetCONNBotListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNBotListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Describes the specified contact. </para><important><para> Contact information remains available in Amazon Connect for 24 months from the InitiationTimestamp, and then it is deleted. Only contact information that is available in Amazon Connect is returned by this API </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Contact'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeContactResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeContactResponse 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.CONN.GetCONNContactCmdlet.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="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet"> <summary> Retrieves the contact attributes for the specified contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet.InitialContactId"> <summary> <para> <para>The identifier of the initial contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetContactAttributesResponse). Specifying the name of a property of type Amazon.Connect.Model.GetContactAttributesResponse 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.CONN.GetCONNContactAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InitialContactId parameter. The -PassThru parameter is deprecated, use -Select '^InitialContactId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationCmdlet"> <summary> Describes a contact evaluation in the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationCmdlet.EvaluationId"> <summary> <para> <para>A unique identifier for the contact evaluation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationCmdlet.Select"> <summary> 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.DescribeContactEvaluationResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeContactEvaluationResponse 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.CONN.GetCONNContactEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationListCmdlet"> <summary> Lists contact evaluations in the specified Amazon Connect instance.<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.CONN.GetCONNContactEvaluationListCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationListCmdlet.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><important><para>This is not expected to be set because the value returned in the previous response is always null.</para></important> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EvaluationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListContactEvaluationsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListContactEvaluationsResponse 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.CONN.GetCONNContactEvaluationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactEvaluationListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowCmdlet"> <summary> Describes the specified flow. <para> You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect Flow language</a>. </para><para> Use the <c>$SAVED</c> alias in the request to describe the <c>SAVED</c> content of a Flow. For example, <c>arn:aws:.../contact-flow/{id}:$SAVED</c>. After a flow is published, <c>$SAVED</c> needs to be supplied to view saved content that has not been published. </para><para> In the response, <b>Status</b> indicates the flow status as either <c>SAVED</c> or <c>PUBLISHED</c>. The <c>PUBLISHED</c> status will initiate validation on the content. <c>SAVED</c> does not initiate validation of the content. <c>SAVED</c> | <c>PUBLISHED</c></para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactFlow'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeContactFlowResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeContactFlowResponse 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.CONN.GetCONNContactFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowListCmdlet"> <summary> Provides information about the flows for the specified Amazon Connect instance. <para> You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect Flow language</a>. </para><para> For more information about flows, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-contact-flows.html">Flows</a> in the <i>Amazon Connect Administrator Guide</i>. </para><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.CONN.GetCONNContactFlowListCmdlet.ContactFlowType"> <summary> <para> <para>The type of flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactFlowSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListContactFlowsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListContactFlowsResponse 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.CONN.GetCONNContactFlowListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleCmdlet"> <summary> Describes the specified flow module. <para> Use the <c>$SAVED</c> alias in the request to describe the <c>SAVED</c> content of a Flow. For example, <c>arn:aws:.../contact-flow/{id}:$SAVED</c>. After a flow is published, <c>$SAVED</c> needs to be supplied to view saved content that has not been published. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleCmdlet.ContactFlowModuleId"> <summary> <para> <para>The identifier of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactFlowModule'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeContactFlowModuleResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeContactFlowModuleResponse 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.CONN.GetCONNContactFlowModuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowModuleId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowModuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleListCmdlet"> <summary> Provides information about the flow modules for the specified Amazon Connect instance.<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.CONN.GetCONNContactFlowModuleListCmdlet.ContactFlowModuleState"> <summary> <para> <para>The state of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactFlowModulesSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListContactFlowModulesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListContactFlowModulesResponse 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.CONN.GetCONNContactFlowModuleListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowModuleListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowVersionListCmdlet"> <summary> Returns all the available versions for the specified Amazon Connect instance and flow identifier.<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.CONN.GetCONNContactFlowVersionListCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowVersionListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowVersionListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactFlowVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListContactFlowVersionsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListContactFlowVersionsResponse 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.CONN.GetCONNContactFlowVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactFlowVersionListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactReferenceListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> For the specified <c>referenceTypes</c>, returns a list of references associated with the contact. <i>References</i> are links to documents that are related to a contact, such as emails, attachments, or URLs. </para><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.CONN.GetCONNContactReferenceListCmdlet.ContactId"> <summary> <para> <para>The identifier of the initial contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactReferenceListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactReferenceListCmdlet.ReferenceType"> <summary> <para> <para>The type of reference.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactReferenceListCmdlet.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><important><para>This is not expected to be set, because the value returned in the previous response is always null.</para></important> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNContactReferenceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReferenceSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListContactReferencesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListContactReferencesResponse 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.CONN.GetCONNContactReferenceListCmdlet.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.CONN.GetCONNContactReferenceListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet"> <summary> Gets the real-time metric data from the specified Amazon Connect instance. <para> For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>. </para><br/><br/>In the AWS.Tools.Connect module, 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.CONN.GetCONNCurrentMetricDataCmdlet.Filters_Channel"> <summary> <para> <para>The channel to use to filter the metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.CurrentMetric"> <summary> <para> <para>The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html">Real-time Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</para><dl><dt>AGENTS_AFTER_CONTACT_WORK</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#aftercallwork-real-time">ACW</a></para></dd><dt>AGENTS_AVAILABLE</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#available-real-time">Available</a></para></dd><dt>AGENTS_ERROR</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#error-real-time">Error</a></para></dd><dt>AGENTS_NON_PRODUCTIVE</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#non-productive-time-real-time">NPT (Non-Productive Time)</a></para></dd><dt>AGENTS_ON_CALL</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time">On contact</a></para></dd><dt>AGENTS_ON_CONTACT</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#on-call-real-time">On contact</a></para></dd><dt>AGENTS_ONLINE</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#online-real-time">Online</a></para></dd><dt>AGENTS_STAFFED</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#staffed-real-time">Staffed</a></para></dd><dt>CONTACTS_IN_QUEUE</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#in-queue-real-time">In queue</a></para></dd><dt>CONTACTS_SCHEDULED</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#scheduled-real-time">Scheduled</a></para></dd><dt>OLDEST_CONTACT_AGE</dt><dd><para>Unit: SECONDS</para><para>When you use groupings, Unit says SECONDS and the Value is returned in SECONDS. </para><para>When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:</para><para><c>{ "Metric": { "Name": "OLDEST_CONTACT_AGE", "Unit": "SECONDS" }, "Value": 24113.0 </c>}</para><para>The actual OLDEST_CONTACT_AGE is 24 seconds.</para><para>When the filter <c>RoutingStepExpression</c> is used, this metric is still calculated from enqueue time. For example, if a contact that has been queued under <c><Expression 1></c> for 10 seconds has expired and <c><Expression 2></c> becomes active, then <c>OLDEST_CONTACT_AGE</c> for this queue will be counted starting from 10, not 0.</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#oldest-real-time">Oldest</a></para></dd><dt>SLOTS_ACTIVE</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#active-real-time">Active</a></para></dd><dt>SLOTS_AVAILABLE</dt><dd><para>Unit: COUNT</para><para>Name in real-time metrics report: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html#availability-real-time">Availability</a></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 <c>QUEUE</c>, the metrics returned apply to each queue rather than aggregated for all queues. </para><ul><li><para>If you group by <c>CHANNEL</c>, you should include a Channels filter. VOICE, CHAT, and TASK channels are supported.</para></li><li><para>If you group by <c>ROUTING_PROFILE</c>, you must include either a queue or routing profile filter. In addition, a routing profile filter is required for metrics <c>CONTACTS_SCHEDULED</c>, <c>CONTACTS_IN_QUEUE</c>, and <c> OLDEST_CONTACT_AGE</c>.</para></li><li><para>If no <c>Grouping</c> is included in the request, a summary of metrics is returned.</para></li><li><para>When using the <c>RoutingStepExpression</c> filter, group by <c>ROUTING_STEP_EXPRESSION</c> is required.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Filters_Queue"> <summary> <para> <para>The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The <c>GetCurrentMetricsData</c> API in particular requires a queue when you include a <c>Filter</c> in your request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Filters_RoutingProfile"> <summary> <para> <para>A list of up to 100 routing profile IDs or ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Filters_RoutingStepExpression"> <summary> <para> <para>A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.SortCriterion"> <summary> <para> <para>The way to sort the resulting response based on metrics. You can enter one sort criteria. By default resources are sorted based on <c>AGENTS_ONLINE</c>, <c>DESCENDING</c>. The metric collection is sorted based on the input metrics.</para><para>Note the following:</para><ul><li><para>Sorting on <c>SLOTS_ACTIVE</c> and <c>SLOTS_AVAILABLE</c> is not supported.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</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 token must use the same request parameters as the request that generated the token.</para> </para> <para> <br/><b>Note:</b> In the AWS.Tools.Connect module, this parameter is only used if you are manually controlling output pagination of the service API call. <br/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.Select"> <summary> 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.GetCurrentMetricDataResponse). Specifying the name of a property of type Amazon.Connect.Model.GetCurrentMetricDataResponse 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.CONN.GetCONNCurrentMetricDataCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentMetricDataCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet"> <summary> Gets the real-time active user data from the specified Amazon Connect instance.<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.CONN.GetCONNCurrentUserDataCmdlet.Filters_Agent"> <summary> <para> <para>A list of up to 100 agent IDs or ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.ContactFilter_ContactState"> <summary> <para> <para>A list of up to 9 <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">contact states</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.Filters_Queue"> <summary> <para> <para>A list of up to 100 queues or ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.Filters_RoutingProfile"> <summary> <para> <para>A list of up to 100 routing profile IDs or ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.Filters_UserHierarchyGroup"> <summary> <para> <para>A UserHierarchyGroup ID or ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserDataList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetCurrentUserDataResponse). Specifying the name of a property of type Amazon.Connect.Model.GetCurrentUserDataResponse 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.CONN.GetCONNCurrentUserDataCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNCurrentUserDataCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNDefaultVocabularyListCmdlet"> <summary> Lists the default vocabularies for the specified Amazon Connect instance.<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.CONN.GetCONNDefaultVocabularyListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNDefaultVocabularyListCmdlet.LanguageCode"> <summary> <para> <para>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNDefaultVocabularyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNDefaultVocabularyListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNDefaultVocabularyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'DefaultVocabularyList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListDefaultVocabulariesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListDefaultVocabulariesResponse 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.CONN.GetCONNDefaultVocabularyListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNDefaultVocabularyListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNEmailAddressCmdlet"> <summary> Describe email address form the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEmailAddressCmdlet.EmailAddressId"> <summary> <para> <para>The identifier of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEmailAddressCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEmailAddressCmdlet.Select"> <summary> 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.DescribeEmailAddressResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeEmailAddressResponse 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.CONN.GetCONNEmailAddressCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormCmdlet"> <summary> Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormCmdlet.EvaluationFormId"> <summary> <para> <para>A unique identifier for the contact evaluation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormCmdlet.EvaluationFormVersion"> <summary> <para> <para>A version of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EvaluationForm'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeEvaluationFormResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeEvaluationFormResponse 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.CONN.GetCONNEvaluationFormCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormListCmdlet"> <summary> Lists evaluation forms in the specified Amazon Connect instance.<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.CONN.GetCONNEvaluationFormListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EvaluationFormSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListEvaluationFormsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListEvaluationFormsResponse 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.CONN.GetCONNEvaluationFormListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormVersionListCmdlet"> <summary> Lists versions of an evaluation form in the specified Amazon Connect instance.<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.CONN.GetCONNEvaluationFormVersionListCmdlet.EvaluationFormId"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormVersionListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormVersionListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EvaluationFormVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListEvaluationFormVersionsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListEvaluationFormVersionsResponse 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.CONN.GetCONNEvaluationFormVersionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNEvaluationFormVersionListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNFederationTokenCmdlet"> <summary> Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is for the Amazon Connect user which corresponds to the IAM credentials that were used to invoke this action. <para> For more information about how SAML sign-in works in Amazon Connect, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/configure-saml.html
 ">Configure SAML with IAM for Amazon Connect in the <i>Amazon Connect Administrator Guide</i>.</a></para><note><para> This API doesn't support root users. If you try to invoke GetFederationToken with root credentials, an error message similar to the following one appears: </para><para><c>Provided identity: Principal: .... User: .... cannot be used for federation with Amazon Connect</c></para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFederationTokenCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFederationTokenCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Credentials'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetFederationTokenResponse). Specifying the name of a property of type Amazon.Connect.Model.GetFederationTokenResponse 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.CONN.GetCONNFederationTokenCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationCmdlet"> <summary> Retrieves the flow associated for a given resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationCmdlet.ResourceId"> <summary> <para> <para>The identifier of the resource.</para><ul><li><para>Amazon Web Services End User Messaging SMS phone number ARN when using <c>SMS_PHONE_NUMBER</c></para></li><li><para>Amazon Web Services End User Messaging Social phone number ARN when using <c>WHATSAPP_MESSAGING_PHONE_NUMBER</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationCmdlet.Select"> <summary> 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.GetFlowAssociationResponse). Specifying the name of a property of type Amazon.Connect.Model.GetFlowAssociationResponse 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.CONN.GetCONNFlowAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationBatchCmdlet"> <summary> Retrieve the flow associations for the given resources. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationBatchCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationBatchCmdlet.ResourceId"> <summary> <para> <para>A list of resource identifiers to retrieve flow associations.</para><ul><li><para>Amazon Web Services End User Messaging SMS phone number ARN when using <c>SMS_PHONE_NUMBER</c></para></li><li><para>Amazon Web Services End User Messaging Social phone number ARN when using <c>WHATSAPP_MESSAGING_PHONE_NUMBER</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationBatchCmdlet.ResourceType"> <summary> <para> <para>The type of resource association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowAssociationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.BatchGetFlowAssociationResponse). Specifying the name of a property of type Amazon.Connect.Model.BatchGetFlowAssociationResponse 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.CONN.GetCONNFlowAssociationBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationListCmdlet"> <summary> List the flow association based on the filters.<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.CONN.GetCONNFlowAssociationListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationListCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'FlowAssociationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListFlowAssociationsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListFlowAssociationsResponse 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.CONN.GetCONNFlowAssociationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNFlowAssociationListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Describes the hours of operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationCmdlet.HoursOfOperationId"> <summary> <para> <para>The identifier for the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HoursOfOperation'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeHoursOfOperationResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeHoursOfOperationResponse 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.CONN.GetCONNHoursOfOperationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationListCmdlet"> <summary> Provides information about the hours of operation for the specified Amazon Connect instance. <para> For more information about hours of operation, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-hours-operation.html">Set the Hours of Operation for a Queue</a> in the <i>Amazon Connect Administrator Guide</i>. </para><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.CONN.GetCONNHoursOfOperationListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HoursOfOperationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListHoursOfOperationsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListHoursOfOperationsResponse 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.CONN.GetCONNHoursOfOperationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNHoursOfOperationListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns the current state of the specified instance identifier. It tracks the instance while it is being created and returns an error status, if applicable. </para><para> If an instance is not created successfully, the instance status reason field returns details relevant to the reason. The instance in a failed state is returned only for 24 hours after the CreateInstance API was invoked. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Instance'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeInstanceResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeInstanceResponse 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.CONN.GetCONNInstanceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Describes the specified instance attribute. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeCmdlet.AttributeType"> <summary> <para> <para>The type of attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attribute'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeInstanceAttributeResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeInstanceAttributeResponse 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="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns a paginated list of all attribute types for the given instance. </para><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.CONN.GetCONNInstanceAttributeListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Attributes'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListInstanceAttributesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListInstanceAttributesResponse 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.CONN.GetCONNInstanceAttributeListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceAttributeListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked. </para><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.CONN.GetCONNInstanceListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'InstanceSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListInstancesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListInstancesResponse 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.CONN.GetCONNInstanceListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Retrieves the current storage configurations for the specified resource type, association ID, and instance ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigCmdlet.AssociationId"> <summary> <para> <para>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageConfig'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeInstanceStorageConfigResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeInstanceStorageConfigResponse 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="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns a paginated list of storage configs for the identified instance and resource type. </para><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.CONN.GetCONNInstanceStorageConfigListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigListCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNInstanceStorageConfigListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StorageConfigs'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListInstanceStorageConfigsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListInstanceStorageConfigsResponse 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.CONN.GetCONNInstanceStorageConfigListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet"> <summary> Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.<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.CONN.GetCONNIntegrationAssociationListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet.IntegrationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the integration.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet.IntegrationType"> <summary> <para> <para>The integration type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'IntegrationAssociationSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListIntegrationAssociationsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListIntegrationAssociationsResponse 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.CONN.GetCONNIntegrationAssociationListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNIntegrationAssociationListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNLambdaFunctionListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant flow blocks. </para><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.CONN.GetCONNLambdaFunctionListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLambdaFunctionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLambdaFunctionListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLambdaFunctionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LambdaFunctions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListLambdaFunctionsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListLambdaFunctionsResponse 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.CONN.GetCONNLambdaFunctionListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLambdaFunctionListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNLexBotListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To return both Amazon Lex V1 and V2 bots, use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListBots.html">ListBots</a> API. </para><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.CONN.GetCONNLexBotListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLexBotListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. If no value is specified, the default is 10. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLexBotListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLexBotListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'LexBots'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListLexBotsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListLexBotsResponse 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.CONN.GetCONNLexBotListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNLexBotListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet"> <summary> Gets historical metric data from the specified Amazon Connect instance. <para> For a description of each historical metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>. </para><note><para> We recommend using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html">GetMetricDataV2</a> API. It provides more flexibility, features, and the ability to query longer time ranges than <c>GetMetricData</c>. Use it to retrieve historical agent and contact metrics for the last 3 months, at varying intervals. You can also use it to build custom dashboards to measure historical queue and agent performance. For example, you can track the number of incoming contacts for the last 7 days, with data split by day, to see how contact volume changed per day of the week. </para></note><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.CONN.GetCONNMetricDataCmdlet.Filters_Channel"> <summary> <para> <para>The channel to use to filter the metrics.</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 start time timestamp.</para><para>The time range between the start and end time 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 queue, 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>If no grouping is specified, a summary of metrics for all queues is returned.</para><para>RoutingStepExpression is not a valid filter for GetMetricData and we recommend switching to GetMetricDataV2 for more up-to-date features.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.HistoricalMetric"> <summary> <para> <para>The metrics to retrieve. Specify the name, unit, and statistic for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical Metrics Definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</para><note><para>This API does not support a contacts incoming metric (there's no CONTACTS_INCOMING metric missing from the documented list). </para></note><dl><dt>ABANDON_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>AFTER_CONTACT_WORK_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>API_CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CALLBACK_CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_ABANDONED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_AGENT_HUNG_UP_FIRST</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_CONSULTED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_HANDLED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_HANDLED_INCOMING</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_HANDLED_OUTBOUND</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_HOLD_ABANDONS</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_MISSED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_QUEUED</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_TRANSFERRED_IN</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_TRANSFERRED_IN_FROM_QUEUE</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_TRANSFERRED_OUT</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt><dd><para>Unit: COUNT</para><para>Statistic: SUM</para></dd><dt>HANDLE_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>HOLD_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>INTERACTION_AND_HOLD_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>INTERACTION_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>OCCUPANCY</dt><dd><para>Unit: PERCENT</para><para>Statistic: AVG</para></dd><dt>QUEUE_ANSWER_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: AVG</para></dd><dt>QUEUED_TIME</dt><dd><para>Unit: SECONDS</para><para>Statistic: MAX</para></dd><dt>SERVICE_LEVEL</dt><dd><para>You can include up to 20 SERVICE_LEVEL metrics in a request.</para><para>Unit: PERCENT</para><para>Statistic: AVG</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you must enter <c>LT</c> (for "Less than"). </para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Filters_Queue"> <summary> <para> <para>The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The <c>GetCurrentMetricsData</c> API in particular requires a queue when you include a <c>Filter</c> in your request. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Filters_RoutingProfile"> <summary> <para> <para>A list of up to 100 routing profile IDs or ARNs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Filters_RoutingStepExpression"> <summary> <para> <para>A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.</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>The start time cannot be earlier than 24 hours before the time of the request. Historical metrics are available only for 24 hours.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetMetricDataResponse). Specifying the name of a property of type Amazon.Connect.Model.GetMetricDataResponse 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.CONN.GetCONNMetricDataCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet"> <summary> Gets metric data from the specified Amazon Connect instance. <para><c>GetMetricDataV2</c> offers more features than <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricData.html">GetMetricData</a>, the previous version of this API. It has new metrics, offers filtering at a metric level, and offers the ability to filter and group data by channels, queues, routing profiles, agents, and agent hierarchy levels. It can retrieve historical data for the last 3 months, at varying intervals. It does not support agent queues. </para><para> For a description of the historical metrics that are supported by <c>GetMetricDataV2</c> and <c>GetMetricData</c>, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>. </para><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.CONN.GetCONNMetricDataV2Cmdlet.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 later than the start time timestamp. It cannot be later than the current timestamp.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.Filter"> <summary> <para> <para>The filters to apply to returned metrics. You can filter on the following resources:</para><ul><li><para>Agents</para></li><li><para>Campaigns</para></li><li><para>Channels</para></li><li><para>Feature</para></li><li><para>Queues</para></li><li><para>Routing profiles</para></li><li><para>Routing step expression</para></li><li><para>User hierarchy groups</para></li></ul><para>At least one filter must be passed from queues, routing profiles, agents, or user hierarchy groups.</para><para>For metrics for outbound campaigns analytics, you can also use campaigns to satisfy at least one filter requirement.</para><para>To filter by phone number, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-historical-metrics-report.html">Create a historical metrics report</a> in the <i>Amazon Connect Administrator Guide</i>.</para><para>Note the following limits:</para><ul><li><para><b>Filter keys</b>: A maximum of 5 filter keys are supported in a single request. Valid filter keys: <c>AGENT</c> | <c>AGENT_HIERARCHY_LEVEL_ONE</c> | <c>AGENT_HIERARCHY_LEVEL_TWO</c> | <c>AGENT_HIERARCHY_LEVEL_THREE</c> | <c>AGENT_HIERARCHY_LEVEL_FOUR</c> | <c>AGENT_HIERARCHY_LEVEL_FIVE</c> | <c>ANSWERING_MACHINE_DETECTION_STATUS</c> | <c> BOT_ID</c> | <c>BOT_ALIAS</c> | <c>BOT_VERSION</c> | <c>BOT_LOCALE</c> | <c>BOT_INTENT_NAME</c> | <c>CAMPAIGN</c> | <c>CAMPAIGN_DELIVERY_EVENT_TYPE</c> |<c>CASE_TEMPLATE_ARN</c> | <c>CASE_STATUS</c> | <c>CHANNEL</c> | <c>contact/segmentAttributes/connect:Subtype</c> | <c>DISCONNECT_REASON</c> | <c>FEATURE</c> | <c>FLOW_ACTION_ID</c> | <c>FLOW_TYPE</c> | <c>FLOWS_MODULE_RESOURCE_ID</c> | <c>FLOWS_NEXT_RESOURCE_ID</c> | <c>FLOWS_NEXT_RESOURCE_QUEUE_ID</c> | <c>FLOWS_OUTCOME_TYPE</c> | <c>FLOWS_RESOURCE_ID</c> | <c>INITIATION_METHOD</c> | <c>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</c> | <c>INVOKING_RESOURCE_TYPE</c> | <c>PARENT_FLOWS_RESOURCE_ID</c> | <c>RESOURCE_PUBLISHED_TIMESTAMP</c> | <c>ROUTING_PROFILE</c> | <c>ROUTING_STEP_EXPRESSION</c> | <c>QUEUE</c> | <c>Q_CONNECT_ENABLED</c> | </para></li><li><para><b>Filter values</b>: A maximum of 100 filter values are supported in a single request. VOICE, CHAT, and TASK are valid <c>filterValue</c> for the CHANNEL filter key. They do not count towards limitation of 100 filter values. For example, a GetMetricDataV2 request can filter by 50 queues, 35 agents, and 15 routing profiles for a total of 100 filter values, along with 3 channel filters. </para><para><c>contact_lens_conversational_analytics</c> is a valid filterValue for the <c>FEATURE</c> filter key. It is available only to contacts analyzed by Contact Lens conversational analytics.</para><para><c>connect:Chat</c>, <c>connect:SMS</c>, <c>connect:Telephony</c>, and <c>connect:WebRTC</c> are valid <c>filterValue</c> examples (not exhaustive) for the <c>contact/segmentAttributes/connect:Subtype filter</c> key.</para><para><c>ROUTING_STEP_EXPRESSION</c> is a valid filter key with a filter value up to 3000 length. This filter is case and order sensitive. JSON string fields must be sorted in ascending order and JSON array order should be kept as is.</para><para><c>Q_CONNECT_ENABLED</c>. TRUE and FALSE are the only valid filterValues for the <c>Q_CONNECT_ENABLED</c> filter key. </para><ul><li><para>TRUE includes all contacts that had Amazon Q in Connect enabled as part of the flow.</para></li><li><para>FALSE includes all contacts that did not have Amazon Q in Connect enabled as part of the flow</para></li></ul><para>This filter is available only for contact record-driven metrics. </para><para><a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-outbound-campaigns_Campaign.html">Campaign</a> ARNs are valid <c>filterValues</c> for the <c>CAMPAIGN</c> filter key.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.Grouping"> <summary> <para> <para>The grouping applied to the metrics that are returned. For example, when results are grouped by queue, the metrics returned are grouped by queue. The values that are returned apply to the metrics for each queue. They are not aggregated for all queues.</para><para>If no grouping is specified, a summary of all metrics is returned.</para><para>Valid grouping keys: <c>AGENT</c> | <c>AGENT_HIERARCHY_LEVEL_ONE</c> | <c>AGENT_HIERARCHY_LEVEL_TWO</c> | <c>AGENT_HIERARCHY_LEVEL_THREE</c> | <c>AGENT_HIERARCHY_LEVEL_FOUR</c> | <c>AGENT_HIERARCHY_LEVEL_FIVE</c> | <c>ANSWERING_MACHINE_DETECTION_STATUS</c> | <c>BOT_ID</c> | <c>BOT_ALIAS</c> | <c>BOT_VERSION</c> | <c>BOT_LOCALE</c> | <c>BOT_INTENT_NAME</c> | <c>CAMPAIGN</c> | <c>CAMPAIGN_DELIVERY_EVENT_TYPE</c> | <c>CASE_TEMPLATE_ARN</c> | <c>CASE_STATUS</c> | <c>CHANNEL</c> | <c>contact/segmentAttributes/connect:Subtype</c> | <c>DISCONNECT_REASON</c> | <c>FLOWS_RESOURCE_ID</c> | <c>FLOWS_MODULE_RESOURCE_ID</c> | <c>FLOW_ACTION_ID</c> | <c>FLOW_TYPE</c> | <c>FLOWS_OUTCOME_TYPE</c> | <c>INITIATION_METHOD</c> | <c>INVOKING_RESOURCE_PUBLISHED_TIMESTAMP</c> | <c>INVOKING_RESOURCE_TYPE</c> | <c>PARENT_FLOWS_RESOURCE_ID</c> | <c>Q_CONNECT_ENABLED</c> | <c>QUEUE</c> | <c>RESOURCE_PUBLISHED_TIMESTAMP</c> | <c>ROUTING_PROFILE</c> | <c>ROUTING_STEP_EXPRESSION</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.Interval_IntervalPeriod"> <summary> <para> <para><c>IntervalPeriod</c>: An aggregated grouping applied to request metrics. Valid <c>IntervalPeriod</c> values are: <c>FIFTEEN_MIN</c> | <c>THIRTY_MIN</c> | <c>HOUR</c> | <c>DAY</c> | <c>WEEK</c> | <c>TOTAL</c>. </para><para>For example, if <c>IntervalPeriod</c> is selected <c>THIRTY_MIN</c>, <c>StartTime</c> and <c>EndTime</c> differs by 1 day, then Amazon Connect returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By default Amazon Connect aggregates results based on the <c>TOTAL</c> interval period. </para><para>The following list describes restrictions on <c>StartTime</c> and <c>EndTime</c> based on what <c>IntervalPeriod</c> is requested. </para><ul><li><para><c>FIFTEEN_MIN</c>: The difference between <c>StartTime</c> and <c>EndTime</c> must be less than 3 days.</para></li><li><para><c>THIRTY_MIN</c>: The difference between <c>StartTime</c> and <c>EndTime</c> must be less than 3 days.</para></li><li><para><c>HOUR</c>: The difference between <c>StartTime</c> and <c>EndTime</c> must be less than 3 days.</para></li><li><para><c>DAY</c>: The difference between <c>StartTime</c> and <c>EndTime</c> must be less than 35 days.</para></li><li><para><c>WEEK</c>: The difference between <c>StartTime</c> and <c>EndTime</c> must be less than 35 days.</para></li><li><para><c>TOTAL</c>: The difference between <c>StartTime</c> and <c>EndTime</c> must be less than 35 days.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.Metric"> <summary> <para> <para>The metrics to retrieve. Specify the name, groupings, and filters for each metric. The following historical metrics are available. For a description of each metric, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html">Historical metrics definitions</a> in the <i>Amazon Connect Administrator Guide</i>.</para><dl><dt>ABANDONMENT_RATE</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#abandonment-rate-historical">Abandonment rate</a></para></dd><dt>AGENT_ADHERENT_TIME</dt><dd><para>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherent-time-historical">Adherent time</a></para></dd><dt>AGENT_ANSWER_RATE</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-answer-rate-historical">Agent answer rate</a></para></dd><dt>AGENT_NON_ADHERENT_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#non-adherent-time">Non-adherent time</a></para></dd><dt>AGENT_NON_RESPONSE</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy </para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-non-response">Agent non-response</a></para></dd><dt>AGENT_NON_RESPONSE_WITHOUT_CUSTOMER_ABANDONS</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>Data for this metric is available starting from October 1, 2023 0:00:00 GMT.</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-nonresponse-no-abandon-historical">Agent non-response without customer abandons</a></para></dd><dt>AGENT_OCCUPANCY</dt><dd><para>Unit: Percentage</para><para>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy </para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#occupancy-historical">Occupancy</a></para></dd><dt>AGENT_SCHEDULE_ADHERENCE</dt><dd><para>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</para><para>Unit: Percent</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#adherence-historical">Adherence</a></para></dd><dt>AGENT_SCHEDULED_TIME</dt><dd><para>This metric is available only in Amazon Web Services Regions where <a href="https://docs.aws.amazon.com/connect/latest/adminguide/regions.html#optimization_region">Forecasting, capacity planning, and scheduling</a> is available.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#scheduled-time-historical">Scheduled time</a></para></dd><dt>AVG_ABANDON_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-abandon-time-historical">Average queue abandon time</a></para></dd><dt>AVG_ACTIVE_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-active-time-historical">Average active time</a></para></dd><dt>AVG_AFTER_CONTACT_WORK_TIME</dt><dd><para>Unit: Seconds</para><para>Valid metric filter key: <c>INITIATION_METHOD</c></para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-acw-time-historical">Average after contact work time</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_AGENT_CONNECTING_TIME</dt><dd><para>Unit: Seconds</para><para>Valid metric filter key: <c>INITIATION_METHOD</c>. For now, this metric only supports the following as <c>INITIATION_METHOD</c>: <c>INBOUND</c> | <c>OUTBOUND</c> | <c>CALLBACK</c> | <c>API</c></para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-avg-agent-api-connecting-time">Average agent API connecting time</a></para><note><para>The <c>Negate</c> key in metric-level filters is not applicable for this metric.</para></note></dd><dt>AVG_AGENT_PAUSE_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-pause-time-historical">Average agent pause time</a></para></dd><dt>AVG_BOT_CONVERSATION_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-time-metric">Average bot conversation time</a></para></dd><dt>AVG_BOT_CONVERSATION_TURNS</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#average-bot-conversation-turns-metric">Average bot conversation turns</a></para></dd><dt>AVG_CASE_RELATED_CONTACTS</dt><dd><para>Unit: Count</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contacts-case-historical">Average contacts per case</a></para></dd><dt>AVG_CASE_RESOLUTION_TIME</dt><dd><para>Unit: Seconds</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-case-resolution-time-historical">Average case resolution time</a></para></dd><dt>AVG_CONTACT_DURATION</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-contact-duration-historical">Average contact duration</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_CONVERSATION_DURATION</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-conversation-duration-historical">Average conversation duration</a></para></dd><dt>AVG_DIALS_PER_MINUTE</dt><dd><para>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</para><para>Unit: Count</para><para>Valid groupings and filters: Agent, Campaign, Queue, Routing Profile</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-dials-historical">Average dials per minute</a></para></dd><dt>AVG_FLOW_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-flow-time-historical">Average flow time</a></para></dd><dt>AVG_GREETING_TIME_AGENT</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-greeting-time-agent-historical">Average agent greeting time</a></para></dd><dt>AVG_HANDLE_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-handle-time-historical">Average handle time</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_HOLD_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-customer-hold-time-historical">Average customer hold time</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_HOLD_TIME_ALL_CONTACTS</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#avg-customer-hold-time-all-contacts-historical">Average customer hold time all contacts</a></para></dd><dt>AVG_HOLDS</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-holds-historical">Average holds</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_INTERACTION_AND_HOLD_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-customer-hold-time-historical">Average agent interaction and customer hold time</a></para></dd><dt>AVG_INTERACTION_TIME</dt><dd><para>Unit: Seconds</para><para>Valid metric filter key: <c>INITIATION_METHOD</c></para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-agent-interaction-time-historical">Average agent interaction time</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_INTERRUPTIONS_AGENT</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-agent-historical">Average agent interruptions</a></para></dd><dt>AVG_INTERRUPTION_TIME_AGENT</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-interruptions-time-agent-historical">Average agent interruption time</a></para></dd><dt>AVG_NON_TALK_TIME</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html##average-non-talk-time-historical">Average non-talk time</a></para></dd><dt>AVG_QUEUE_ANSWER_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-queue-answer-time-historical">Average queue answer time</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>AVG_RESOLUTION_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-resolution-time-historical">Average resolution time</a></para></dd><dt>AVG_TALK_TIME</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-historical">Average talk time</a></para></dd><dt>AVG_TALK_TIME_AGENT</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-agent-historical">Average agent talk time</a></para></dd><dt>AVG_TALK_TIME_CUSTOMER</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-talk-time-customer-historical">Average customer talk time</a></para></dd><dt>AVG_WAIT_TIME_AFTER_CUSTOMER_CONNECTION</dt><dd><para>This metric is available only for outbound campaigns that use the agent assisted voice and automated voice delivery modes.</para><para>Unit: Seconds</para><para>Valid groupings and filters: Campaign</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#average-wait-time-historical">Average wait time after customer connection</a></para></dd><dt>BOT_CONVERSATIONS_COMPLETED</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-conversations-completed-metric">Bot conversations</a></para></dd><dt>BOT_INTENTS_COMPLETED</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#bot-intents-completed-metric">Bot intents completed</a></para></dd><dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X</dt><dd><para>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</para><para>Unit: Count</para><para>Valid groupings and filters: Agent, Campaign</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you must enter <c>GT</c> (for <i>Greater than</i>).</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-historical">Campaign contacts abandoned after X</a></para></dd><dt>CAMPAIGN_CONTACTS_ABANDONED_AFTER_X_RATE</dt><dd><para>This metric is available only for outbound campaigns using the agent assisted voice and automated voice delivery modes.</para><para>Unit: Percent</para><para>Valid groupings and filters: Agent, Campaign</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you must enter <c>GT</c> (for <i>Greater than</i>).</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-contacts-abandoned-rate-historical">Campaign contacts abandoned after X rate</a></para></dd><dt>CAMPAIGN_INTERACTIONS</dt><dd><para>This metric is available only for outbound campaigns using the email delivery mode. </para><para>Unit: Count</para><para>Valid metric filter key: CAMPAIGN_INTERACTION_EVENT_TYPE</para><para>Valid groupings and filters: Campaign</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-interactions-historical">Campaign interactions</a></para></dd><dt>CAMPAIGN_SEND_ATTEMPTS</dt><dd><para>This metric is available only for outbound campaigns.</para><para>Unit: Count</para><para>Valid groupings and filters: Campaign, Channel, contact/segmentAttributes/connect:Subtype </para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#campaign-send-attempts-historical">Campaign send attempts</a></para></dd><dt>CASES_CREATED</dt><dd><para>Unit: Count</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-created-historical">Cases created</a></para></dd><dt>CONTACTS_CREATED</dt><dd><para>Unit: Count</para><para>Valid metric filter key: <c>INITIATION_METHOD</c></para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-created-historical">Contacts created</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>CONTACTS_HANDLED</dt><dd><para>Unit: Count</para><para>Valid metric filter key: <c>INITIATION_METHOD</c>, <c>DISCONNECT_REASON</c></para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#api-contacts-handled-historical">API contacts handled</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>CONTACTS_HANDLED_BY_CONNECTED_TO_AGENT</dt><dd><para>Unit: Count</para><para>Valid metric filter key: <c>INITIATION_METHOD</c></para><para>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical">Contacts handled (connected to agent timestamp)</a></para></dd><dt>CONTACTS_HOLD_ABANDONS</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-handled-by-connected-to-agent-historical">Contacts hold disconnect</a></para></dd><dt>CONTACTS_ON_HOLD_AGENT_DISCONNECT</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-agent-disconnect-historical">Contacts hold agent disconnect</a></para></dd><dt>CONTACTS_ON_HOLD_CUSTOMER_DISCONNECT</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical">Contacts hold customer disconnect</a></para></dd><dt>CONTACTS_PUT_ON_HOLD</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-hold-customer-disconnect-historical">Contacts put on hold</a></para></dd><dt>CONTACTS_TRANSFERRED_OUT_EXTERNAL</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-external-historical">Contacts transferred out external</a></para></dd><dt>CONTACTS_TRANSFERRED_OUT_INTERNAL</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-internal-historical">Contacts transferred out internal</a></para></dd><dt>CONTACTS_QUEUED</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-historical">Contacts queued</a></para></dd><dt>CONTACTS_QUEUED_BY_ENQUEUE</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-queued-by-enqueue-historical">Contacts queued (enqueue timestamp)</a></para></dd><dt>CONTACTS_REMOVED_FROM_QUEUE_IN_X</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you can use <c>LT</c> (for "Less than") or <c>LTE</c> (for "Less than equal").</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-removed-historical">Contacts removed from queue in X seconds</a></para></dd><dt>CONTACTS_RESOLVED_IN_X</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you can use <c>LT</c> (for "Less than") or <c>LTE</c> (for "Less than equal").</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-resolved-historical">Contacts resolved in X</a></para></dd><dt>CONTACTS_TRANSFERRED_OUT</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-historical">Contacts transferred out</a></para><note><para>Feature is a valid filter but not a valid grouping.</para></note></dd><dt>CONTACTS_TRANSFERRED_OUT_BY_AGENT</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical">Contacts transferred out by agent</a></para></dd><dt>CONTACTS_TRANSFERRED_OUT_FROM_QUEUE</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-transferred-out-by-agent-historical">Contacts transferred out queue</a></para></dd><dt>CURRENT_CASES</dt><dd><para>Unit: Count</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#current-cases-historical">Current cases</a></para></dd><dt>DELIVERY_ATTEMPTS</dt><dd><para>This metric is available only for outbound campaigns.</para><para>Unit: Count</para><para>Valid metric filter key: <c>ANSWERING_MACHINE_DETECTION_STATUS</c>, <c>CAMPAIGN_DELIVERY_EVENT_TYPE</c>, <c>DISCONNECT_REASON</c></para><para>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Campaign Delivery EventType, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempts-historical">Delivery attempts</a></para><note><para>Campaign Delivery EventType filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </para></note></dd><dt>DELIVERY_ATTEMPT_DISPOSITION_RATE</dt><dd><para>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled.</para><para>Unit: Percent</para><para>Valid metric filter key: <c>ANSWERING_MACHINE_DETECTION_STATUS</c>, <c>CAMPAIGN_DELIVERY_EVENT_TYPE</c>, <c>DISCONNECT_REASON</c></para><para>Valid groupings and filters: Agent, Answering Machine Detection Status, Campaign, Channel, contact/segmentAttributes/connect:Subtype, Disconnect Reason, Queue, Routing Profile</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#delivery-attempt-disposition-rate-historical">Delivery attempt disposition rate</a></para><note><para>Campaign Delivery Event Type filter and grouping are only available for SMS and Email campaign delivery modes. Agent, Queue, Routing Profile, Answering Machine Detection Status and Disconnect Reason are only available for agent assisted voice and automated voice delivery modes. </para></note></dd><dt>FLOWS_OUTCOME</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-historical">Flows outcome</a></para></dd><dt>FLOWS_STARTED</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows resource ID, Initiation method, Resource published timestamp</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-started-historical">Flows started</a></para></dd><dt>HUMAN_ANSWERED_CALLS</dt><dd><para>This metric is available only for outbound campaigns. Dispositions for the agent assisted voice and automated voice delivery modes are only available with answering machine detection enabled. </para><para>Unit: Count</para><para>Valid groupings and filters: Agent, Campaign</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#human-answered-historical">Human answered</a></para></dd><dt>MAX_FLOW_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-flow-time-historical">Maximum flow time</a></para></dd><dt>MAX_QUEUED_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#maximum-queued-time-historical">Maximum queued time</a></para></dd><dt>MIN_FLOW_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#minimum-flow-time-historical">Minimum flow time</a></para></dd><dt>PERCENT_BOT_CONVERSATIONS_OUTCOME</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-conversations-outcome-metric">Percent bot conversations outcome</a></para></dd><dt>PERCENT_BOT_INTENTS_OUTCOME</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Bot ID, Bot alias, Bot version, Bot locale, Bot intent name, Flows resource ID, Flows module resource ID, Flow type, Flow action ID, Invoking resource published timestamp, Initiation method, Invoking resource type, Parent flows resource ID</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/bot-metrics.html#percent-bot-intents-outcome-metric">Percent bot intents outcome</a></para></dd><dt>PERCENT_CASES_FIRST_CONTACT_RESOLVED</dt><dd><para>Unit: Percent</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-first-contact-historical">Cases resolved on first contact</a></para></dd><dt>PERCENT_CONTACTS_STEP_EXPIRED</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Queue, RoutingStepExpression</para><para>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</para></dd><dt>PERCENT_CONTACTS_STEP_JOINED</dt><dd><para>Unit: Percent</para><para>Valid groupings and filters: Queue, RoutingStepExpression</para><para>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</para></dd><dt>PERCENT_FLOWS_OUTCOME</dt><dd><para>Unit: Percent</para><para>Valid metric filter key: <c>FLOWS_OUTCOME_TYPE</c></para><para>Valid groupings and filters: Channel, contact/segmentAttributes/connect:Subtype, Flow type, Flows module resource ID, Flows next resource ID, Flows next resource queue ID, Flows outcome type, Flows resource ID, Initiation method, Resource published timestamp</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#flows-outcome-percentage-historical">Flows outcome percentage</a>.</para><note><para>The <c>FLOWS_OUTCOME_TYPE</c> is not a valid grouping.</para></note></dd><dt>PERCENT_NON_TALK_TIME</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Percentage</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ntt-historical">Non-talk time percent</a></para></dd><dt>PERCENT_TALK_TIME</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Percentage</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#tt-historical">Talk time percent</a></para></dd><dt>PERCENT_TALK_TIME_AGENT</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Percentage</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttagent-historical">Agent talk time percent</a></para></dd><dt>PERCENT_TALK_TIME_CUSTOMER</dt><dd><para>This metric is available only for contacts analyzed by Contact Lens conversational analytics.</para><para>Unit: Percentage</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#ttcustomer-historical">Customer talk time percent</a></para></dd><dt>REOPENED_CASE_ACTIONS</dt><dd><para>Unit: Count</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-reopened-historical">Cases reopened</a></para></dd><dt>RESOLVED_CASE_ACTIONS</dt><dd><para>Unit: Count</para><para>Required filter key: CASE_TEMPLATE_ARN</para><para>Valid groupings and filters: CASE_TEMPLATE_ARN, CASE_STATUS</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#cases-resolved-historical">Cases resolved</a></para></dd><dt>SERVICE_LEVEL</dt><dd><para>You can include up to 20 SERVICE_LEVEL metrics in a request.</para><para>Unit: Percent</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Q in Connect</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you can use <c>LT</c> (for "Less than") or <c>LTE</c> (for "Less than equal").</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#service-level-historical">Service level X</a></para></dd><dt>STEP_CONTACTS_QUEUED</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, RoutingStepExpression</para><para>UI name: This metric is available in Real-time Metrics UI but not on the Historical Metrics UI.</para></dd><dt>SUM_AFTER_CONTACT_WORK_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#acw-historical">After contact work time</a></para></dd><dt>SUM_CONNECTING_TIME_AGENT</dt><dd><para>Unit: Seconds</para><para>Valid metric filter key: <c>INITIATION_METHOD</c>. This metric only supports the following filter keys as <c>INITIATION_METHOD</c>: <c>INBOUND</c> | <c>OUTBOUND</c> | <c>CALLBACK</c> | <c>API</c></para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#htm-agent-api-connecting-time">Agent API connecting time</a></para><note><para>The <c>Negate</c> key in metric-level filters is not applicable for this metric.</para></note></dd><dt>CONTACTS_ABANDONED</dt><dd><para>Unit: Count</para><para>Metric filter: </para><ul><li><para>Valid values: <c>API</c>| <c>Incoming</c> | <c>Outbound</c> | <c>Transfer</c> | <c>Callback</c> | <c>Queue_Transfer</c>| <c>Disconnect</c></para></li></ul><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, RoutingStepExpression, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-historical">Contact abandoned</a></para></dd><dt>SUM_CONTACTS_ABANDONED_IN_X</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you can use <c>LT</c> (for "Less than") or <c>LTE</c> (for "Less than equal").</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-abandoned-x-historical">Contacts abandoned in X seconds</a></para></dd><dt>SUM_CONTACTS_ANSWERED_IN_X</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>Threshold: For <c>ThresholdValue</c>, enter any whole number from 1 to 604800 (inclusive), in seconds. For <c>Comparison</c>, you can use <c>LT</c> (for "Less than") or <c>LTE</c> (for "Less than equal").</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contacts-answered-x-historical">Contacts answered in X seconds</a></para></dd><dt>SUM_CONTACT_FLOW_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-flow-time-historical">Contact flow time</a></para></dd><dt>SUM_CONTACT_TIME_AGENT</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-on-contact-time-historical">Agent on contact time</a></para></dd><dt>SUM_CONTACTS_DISCONNECTED </dt><dd><para>Valid metric filter key: <c>DISCONNECT_REASON</c></para><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-disconnected-historical">Contact disconnected</a></para></dd><dt>SUM_ERROR_STATUS_TIME_AGENT</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#error-status-time-historical">Error status time</a></para></dd><dt>SUM_HANDLE_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#contact-handle-time-historical">Contact handle time</a></para></dd><dt>SUM_HOLD_TIME</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#customer-hold-time-historical">Customer hold time</a></para></dd><dt>SUM_IDLE_TIME_AGENT</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-idle-time-historica">Agent idle time</a></para></dd><dt>SUM_INTERACTION_AND_HOLD_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-hold-time-historical">Agent interaction and hold time</a></para></dd><dt>SUM_INTERACTION_TIME</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#agent-interaction-time-historical">Agent interaction time</a></para></dd><dt>SUM_NON_PRODUCTIVE_TIME_AGENT</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#npt-historical">Non-Productive Time</a></para></dd><dt>SUM_ONLINE_TIME_AGENT</dt><dd><para>Unit: Seconds</para><para>Valid groupings and filters: Routing Profile, Agent, Agent Hierarchy</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#online-time-historical">Online time</a></para></dd><dt>SUM_RETRY_CALLBACK_ATTEMPTS</dt><dd><para>Unit: Count</para><para>Valid groupings and filters: Queue, Channel, Routing Profile, contact/segmentAttributes/connect:Subtype, Q in Connect</para><para>UI name: <a href="https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html#callback-attempts-historical">Callback attempts</a></para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. This includes the <c>instanceId</c> an Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.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 before the end time timestamp. The start and end time depends on the <c>IntervalPeriod</c> selected. By default the time range between start and end time is 35 days. Historical metrics are available for 3 months.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.Interval_TimeZone"> <summary> <para> <para>The timezone applied to requested metrics.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNMetricDataV2Cmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'MetricResults'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetMetricDataV2Response). Specifying the name of a property of type Amazon.Connect.Model.GetMetricDataV2Response 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.CONN.GetCONNMetricDataV2Cmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberCmdlet"> <summary> Gets details and status of a phone number that’s claimed to your Amazon Connect instance or traffic distribution group. <important><para> If the number is claimed to a traffic distribution group, and you are calling in the Amazon Web Services Region where the traffic distribution group was created, you can use either a phone number ARN or UUID value for the <c>PhoneNumberId</c> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you receive a <c>ResourceNotFoundException</c>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>A unique identifier for the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ClaimedPhoneNumberSummary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribePhoneNumberResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribePhoneNumberResponse 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.CONN.GetCONNPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet"> <summary> Provides information about the phone numbers for the specified Amazon Connect instance. <para> For more information about phone numbers, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>. </para><important><ul><li><para> We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to return phone number types. ListPhoneNumbers doesn't support number types <c>UIFN</c>, <c>SHARED</c>, <c>THIRD_PARTY_TF</c>, and <c>THIRD_PARTY_DID</c>. While it returns numbers of those types, it incorrectly lists them as <c>TOLL_FREE</c> or <c>DID</c>. </para></li><li><para> The phone number <c>Arn</c> value that is returned from each of the items in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbers.html#connect-ListPhoneNumbers-response-PhoneNumberSummaryList">PhoneNumberSummaryList</a> cannot be used to tag phone number resources. It will fail with a <c>ResourceNotFoundException</c>. Instead, use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> API. It returns the new phone number ARN that can be used to tag phone number resources. </para></li></ul></important><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.CONN.GetCONNPhoneNumberListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet.PhoneNumberCountryCode"> <summary> <para> <para>The ISO country code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet.PhoneNumberType"> <summary> <para> <para>The type of phone number.</para><note><para>We recommend using <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> to return phone number types. While ListPhoneNumbers returns number types <c>UIFN</c>, <c>SHARED</c>, <c>THIRD_PARTY_TF</c>, and <c>THIRD_PARTY_DID</c>, it incorrectly lists them as <c>TOLL_FREE</c> or <c>DID</c>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PhoneNumberSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListPhoneNumbersResponse). Specifying the name of a property of type Amazon.Connect.Model.ListPhoneNumbersResponse 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.CONN.GetCONNPhoneNumberListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumberListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet"> <summary> Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided <c>TargetArn</c> is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with traffic distribution group. <para> For more information about phone numbers, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/contact-center-phone-number.html">Set Up Phone Numbers for Your Contact Center</a> in the <i>Amazon Connect Administrator Guide</i>. </para><note><ul><li><para> When given an instance ARN, <c>ListPhoneNumbersV2</c> returns only the phone numbers claimed to the instance. </para></li><li><para> When given a traffic distribution group ARN <c>ListPhoneNumbersV2</c> returns only the phone numbers claimed to the traffic distribution group. </para></li></ul></note><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.CONN.GetCONNPhoneNumbersV2ListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. If both <c>TargetArn</c> and <c>InstanceId</c> are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same AWS Region as the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.PhoneNumberCountryCode"> <summary> <para> <para>The ISO country code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.PhoneNumberPrefix"> <summary> <para> <para>The prefix of the phone number. If provided, it must contain <c>+</c> as part of the country code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.PhoneNumberType"> <summary> <para> <para>The type of phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.TargetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. If both <c>TargetArn</c> and <c>InstanceId</c> input are not provided, this API lists numbers claimed to all the Amazon Connect instances belonging to your account in the same Amazon Web Services Region as the request.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPhoneNumbersV2ListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ListPhoneNumbersSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListPhoneNumbersV2Response). Specifying the name of a property of type Amazon.Connect.Model.ListPhoneNumbersV2Response 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.CONN.GetCONNPhoneNumbersV2ListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeCmdlet"> <summary> Describes a predefined attribute for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeCmdlet.Name"> <summary> <para> <para>The name of the predefined attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PredefinedAttribute'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribePredefinedAttributeResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribePredefinedAttributeResponse 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.CONN.GetCONNPredefinedAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeListCmdlet"> <summary> Lists predefined attributes for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>.<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.CONN.GetCONNPredefinedAttributeListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PredefinedAttributeSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListPredefinedAttributesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListPredefinedAttributesResponse 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.CONN.GetCONNPredefinedAttributeListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPredefinedAttributeListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptCmdlet"> <summary> Describes the prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptCmdlet.PromptId"> <summary> <para> <para>A unique identifier for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Prompt'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribePromptResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribePromptResponse 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.CONN.GetCONNPromptCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptId parameter. The -PassThru parameter is deprecated, use -Select '^PromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptFileCmdlet"> <summary> Gets the prompt file. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptFileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptFileCmdlet.PromptId"> <summary> <para> <para>A unique identifier for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptFileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PromptPresignedUrl'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.GetPromptFileResponse). Specifying the name of a property of type Amazon.Connect.Model.GetPromptFileResponse 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.CONN.GetCONNPromptFileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PromptId parameter. The -PassThru parameter is deprecated, use -Select '^PromptId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptListCmdlet"> <summary> Provides information about the prompts for the specified Amazon Connect instance.<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.CONN.GetCONNPromptListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'PromptSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListPromptsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListPromptsResponse 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.CONN.GetCONNPromptListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNPromptListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Describes the specified queue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Queue'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeQueueResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeQueueResponse 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.CONN.GetCONNQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueListCmdlet"> <summary> Provides information about the queues for the specified Amazon Connect instance. <para> If you do not specify a <c>QueueTypes</c> parameter, both standard and agent queues are returned. This might cause an unexpected truncation of results if you have more than 1000 agents and you limit the number of results of the API call in code. </para><para> For more information about queues, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-queues-standard-and-agent.html">Queues: Standard and Agent</a> in the <i>Amazon Connect Administrator Guide</i>. </para><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.CONN.GetCONNQueueListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueListCmdlet.QueueType"> <summary> <para> <para>The type of queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QueueSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListQueuesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListQueuesResponse 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.CONN.GetCONNQueueListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueQuickConnectListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Lists the quick connects associated with a queue. </para><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.CONN.GetCONNQueueQuickConnectListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueQuickConnectListCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueQuickConnectListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueQuickConnectListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueQuickConnectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickConnectSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListQueueQuickConnectsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListQueueQuickConnectsResponse 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.CONN.GetCONNQueueQuickConnectListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQueueQuickConnectListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectCmdlet"> <summary> Describes the quick connect. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectCmdlet.QuickConnectId"> <summary> <para> <para>The identifier for the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickConnect'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeQuickConnectResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeQuickConnectResponse 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.CONN.GetCONNQuickConnectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectListCmdlet"> <summary> Provides information about the quick connects for the specified Amazon Connect instance.<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.CONN.GetCONNQuickConnectListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectListCmdlet.QuickConnectType"> <summary> <para> <para>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'QuickConnectSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListQuickConnectsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListQuickConnectsResponse 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.CONN.GetCONNQuickConnectListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNQuickConnectListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet"> <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.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.OutputType"> <summary> <para> <para>The Contact Lens output type to be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.SegmentType"> <summary> <para> <para>Enum with segment types . Each value corresponds to a segment type returned in the segments list of the API. Each segment type has its own structure. Different channels may have different sets of supported segment types.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.Select"> <summary> 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.ListRealtimeContactAnalysisSegmentsV2Response). Specifying the name of a property of type Amazon.Connect.Model.ListRealtimeContactAnalysisSegmentsV2Response 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.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.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.CONN.GetCONNRealtimeContactAnalysisSegmentsV2ListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNResourceTagCmdlet"> <summary> Lists the tags for the specified resource. <para> For sample policies that use tags, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_id-based-policy-examples.html">Amazon Connect Identity-Based Policy Examples</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource. All Amazon Connect resources (instances, queues, flows, routing profiles, etc) have an ARN. To locate the ARN for an instance, for example, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">Find your Amazon Connect instance ID/ARN</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.Connect.Model.ListTagsForResourceResponse 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.CONN.GetCONNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileCmdlet"> <summary> Describes the specified routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RoutingProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeRoutingProfileResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeRoutingProfileResponse 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.CONN.GetCONNRoutingProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet"> <summary> Provides summary information about the routing profiles for the specified Amazon Connect instance. <para> For more information about routing profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing.html">Routing Profiles</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/routing-profiles.html">Create a Routing Profile</a> in the <i>Amazon Connect Administrator Guide</i>. </para><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.CONN.GetCONNRoutingProfileListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RoutingProfileSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListRoutingProfilesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListRoutingProfilesResponse 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.CONN.GetCONNRoutingProfileListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileQueueListCmdlet"> <summary> Lists the queues associated with a routing profile.<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.CONN.GetCONNRoutingProfileQueueListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileQueueListCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileQueueListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileQueueListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileQueueListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RoutingProfileQueueConfigSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListRoutingProfileQueuesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListRoutingProfileQueuesResponse 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.CONN.GetCONNRoutingProfileQueueListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRoutingProfileQueueListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleCmdlet"> <summary> Describes a rule for the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleCmdlet.RuleId"> <summary> <para> <para>A unique identifier for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Rule'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeRuleResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeRuleResponse 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.CONN.GetCONNRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleId parameter. The -PassThru parameter is deprecated, use -Select '^RuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet"> <summary> List all rules for the specified Amazon Connect instance.<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.CONN.GetCONNRuleListCmdlet.EventSourceName"> <summary> <para> <para>The name of the event source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet.PublishStatus"> <summary> <para> <para>The publish status of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RuleSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListRulesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListRulesResponse 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.CONN.GetCONNRuleListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNRuleListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityKeyListCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Returns a paginated list of all security keys associated with the instance. </para><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.CONN.GetCONNSecurityKeyListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityKeyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityKeyListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityKeyListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityKeys'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListSecurityKeysResponse). Specifying the name of a property of type Amazon.Connect.Model.ListSecurityKeysResponse 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.CONN.GetCONNSecurityKeyListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityKeyListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileCmdlet"> <summary> Gets basic information about the security profile. <para> For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileCmdlet.SecurityProfileId"> <summary> <para> <para>The identifier for the security profle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityProfile'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeSecurityProfileResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeSecurityProfileResponse 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.CONN.GetCONNSecurityProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SecurityProfileId parameter. The -PassThru parameter is deprecated, use -Select '^SecurityProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileApplicationListCmdlet"> <summary> Returns a list of third-party applications in a specific security profile.<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.CONN.GetCONNSecurityProfileApplicationListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileApplicationListCmdlet.SecurityProfileId"> <summary> <para> <para>The identifier for the security profle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileApplicationListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileApplicationListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileApplicationListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Applications'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListSecurityProfileApplicationsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListSecurityProfileApplicationsResponse 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.CONN.GetCONNSecurityProfileApplicationListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SecurityProfileId parameter. The -PassThru parameter is deprecated, use -Select '^SecurityProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileApplicationListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet"> <summary> Provides summary information about the security profiles for the specified Amazon Connect instance. <para> For more information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para><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.CONN.GetCONNSecurityProfileListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'SecurityProfileSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListSecurityProfilesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListSecurityProfilesResponse 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.CONN.GetCONNSecurityProfileListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfileListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfilePermissionListCmdlet"> <summary> Lists the permissions granted to a security profile. <para> For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para><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.CONN.GetCONNSecurityProfilePermissionListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfilePermissionListCmdlet.SecurityProfileId"> <summary> <para> <para>The identifier for the security profle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfilePermissionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfilePermissionListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfilePermissionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Permissions'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListSecurityProfilePermissionsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListSecurityProfilePermissionsResponse 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.CONN.GetCONNSecurityProfilePermissionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SecurityProfileId parameter. The -PassThru parameter is deprecated, use -Select '^SecurityProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNSecurityProfilePermissionListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateCmdlet"> <summary> Gets details about a specific task template in the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateCmdlet.SnapshotVersion"> <summary> <para> <para>The system generated version of a task template that is associated with a task, when the task is created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateCmdlet.TaskTemplateId"> <summary> <para> <para>A unique identifier for the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateCmdlet.Select"> <summary> 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.GetTaskTemplateResponse). Specifying the name of a property of type Amazon.Connect.Model.GetTaskTemplateResponse 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.CONN.GetCONNTaskTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskTemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TaskTemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet"> <summary> Lists task templates for the specified Amazon Connect instance.<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.CONN.GetCONNTaskTemplateListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet.Name"> <summary> <para> <para>The name of the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet.Status"> <summary> <para> <para>Marks a template as <c>ACTIVE</c> or <c>INACTIVE</c> for a task to refer to it. Tasks can only be created from <c>ACTIVE</c> templates. If a template is marked as <c>INACTIVE</c>, then a task that refers to this template cannot be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para><important><para>It is not expected that you set this.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet.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><important><para>It is not expected that you set this because the value returned in the previous response is always null.</para></important> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TaskTemplates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListTaskTemplatesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListTaskTemplatesResponse 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.CONN.GetCONNTaskTemplateListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTaskTemplateListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionCmdlet"> <summary> Retrieves the current traffic distribution for a given traffic distribution group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionCmdlet.Id"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionCmdlet.Select"> <summary> 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.GetTrafficDistributionResponse). Specifying the name of a property of type Amazon.Connect.Model.GetTrafficDistributionResponse 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.CONN.GetCONNTrafficDistributionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupCmdlet"> <summary> Gets details and status of a traffic distribution group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupCmdlet.TrafficDistributionGroupId"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrafficDistributionGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeTrafficDistributionGroupResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeTrafficDistributionGroupResponse 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.CONN.GetCONNTrafficDistributionGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrafficDistributionGroupId parameter. The -PassThru parameter is deprecated, use -Select '^TrafficDistributionGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupListCmdlet"> <summary> Lists traffic distribution groups.<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.CONN.GetCONNTrafficDistributionGroupListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrafficDistributionGroupSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListTrafficDistributionGroupsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListTrafficDistributionGroupsResponse 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.CONN.GetCONNTrafficDistributionGroupListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupUserListCmdlet"> <summary> Lists traffic distribution group users.<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.CONN.GetCONNTrafficDistributionGroupUserListCmdlet.TrafficDistributionGroupId"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupUserListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TrafficDistributionGroupUserSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListTrafficDistributionGroupUsersResponse). Specifying the name of a property of type Amazon.Connect.Model.ListTrafficDistributionGroupUsersResponse 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.CONN.GetCONNTrafficDistributionGroupUserListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrafficDistributionGroupId parameter. The -PassThru parameter is deprecated, use -Select '^TrafficDistributionGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNTrafficDistributionGroupUserListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUseCaseListCmdlet"> <summary> Lists the use cases for the integration association.<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.CONN.GetCONNUseCaseListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUseCaseListCmdlet.IntegrationAssociationId"> <summary> <para> <para>The identifier for the integration association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUseCaseListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUseCaseListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUseCaseListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UseCaseSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListUseCasesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListUseCasesResponse 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.CONN.GetCONNUseCaseListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUseCaseListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet"> <summary> Describes the specified user. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID in the Amazon Connect console</a> (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'User'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeUserResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeUserResponse 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.CONN.GetCONNUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet"> <summary> Describes the specified hierarchy group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HierarchyGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeUserHierarchyGroupResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeUserHierarchyGroupResponse 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.CONN.GetCONNUserHierarchyGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the HierarchyGroupId parameter. The -PassThru parameter is deprecated, use -Select '^HierarchyGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet"> <summary> Provides summary information about the hierarchy groups for the specified Amazon Connect instance. <para> For more information about agent hierarchies, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html">Set Up Agent Hierarchies</a> in the <i>Amazon Connect Administrator Guide</i>. </para><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.CONN.GetCONNUserHierarchyGroupListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserHierarchyGroupSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListUserHierarchyGroupsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListUserHierarchyGroupsResponse 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.CONN.GetCONNUserHierarchyGroupListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyGroupListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyStructureCmdlet"> <summary> Describes the hierarchy structure of the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyStructureCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserHierarchyStructureCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'HierarchyStructure'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeUserHierarchyStructureResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeUserHierarchyStructureResponse 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.CONN.GetCONNUserHierarchyStructureCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet"> <summary> Provides summary information about the users for the specified Amazon Connect instance.<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.CONN.GetCONNUserListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> <para> <br/><b>Note:</b> In AWSPowerShell and AWSPowerShell.NetCore this parameter is used to limit the total number of items returned by the cmdlet. <br/>In AWS.Tools this parameter is simply passed to the service to specify how many items should be returned by each service call. <br/>Pipe the output of this cmdlet into Select-Object -First to terminate retrieving data pages early and control the number of items returned. </para> <para>If a value for this parameter is not specified the cmdlet will use a default value of '<b>100</b>'.</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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'UserSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListUsersResponse). Specifying the name of a property of type Amazon.Connect.Model.ListUsersResponse 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.CONN.GetCONNUserListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserProficiencyListCmdlet"> <summary> Lists proficiencies associated with a user.<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.CONN.GetCONNUserProficiencyListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserProficiencyListCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserProficiencyListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserProficiencyListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserProficiencyListCmdlet.Select"> <summary> 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.ListUserProficienciesResponse). Specifying the name of a property of type Amazon.Connect.Model.ListUserProficienciesResponse 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.CONN.GetCONNUserProficiencyListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNUserProficiencyListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewCmdlet"> <summary> Retrieves the view for the specified Amazon Connect instance and view identifier. <para> The view identifier can be supplied as a ViewId or ARN. </para><para><c>$SAVED</c> needs to be supplied if a view is unpublished. </para><para> The view identifier can contain an optional qualifier, for example, <c><view-id>:$SAVED</c>, which is either an actual version number or an Amazon Connect managed qualifier <c>$SAVED | $LATEST</c>. If it is not supplied, then <c>$LATEST</c> is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewCmdlet.ViewId"> <summary> <para> <para>The ViewId of the view. This must be an ARN for Amazon Web Services managed views.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'View'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeViewResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeViewResponse 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.CONN.GetCONNViewCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewListCmdlet"> <summary> Returns views in the given instance. <para> Results are sorted primarily by type, and secondarily by name. </para><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.CONN.GetCONNViewListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewListCmdlet.Type"> <summary> <para> <para>The type of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ViewsSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListViewsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListViewsResponse 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.CONN.GetCONNViewListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewVersionListCmdlet"> <summary> Returns all the available versions for the specified Amazon Connect instance and view identifier. <para> Results will be sorted from highest to lowest. </para><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.CONN.GetCONNViewVersionListCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewVersionListCmdlet.ViewId"> <summary> <para> <para>The identifier of the view. Both <c>ViewArn</c> and <c>ViewId</c> can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewVersionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page. The default MaxResult size is 100.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewVersionListCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewVersionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ViewVersionSummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ListViewVersionsResponse). Specifying the name of a property of type Amazon.Connect.Model.ListViewVersionsResponse 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.CONN.GetCONNViewVersionListCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNViewVersionListCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.GetCONNVocabularyCmdlet"> <summary> Describes the specified vocabulary. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNVocabularyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNVocabularyCmdlet.VocabularyId"> <summary> <para> <para>The identifier of the custom vocabulary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.GetCONNVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Vocabulary'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DescribeVocabularyResponse). Specifying the name of a property of type Amazon.Connect.Model.DescribeVocabularyResponse 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.CONN.GetCONNVocabularyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet"> <summary> Imports a claimed phone number from an external service, such as Amazon Web Services End User Messaging, into an Amazon Connect instance. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance was created. <important><para> Call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API to verify the status of a previous <c>ImportPhoneNumber</c> operation. </para></important><para> If you plan to claim or import numbers and then release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. </para><para> By default you can claim or import and then release up to 200% of your maximum number of active phone numbers. If you claim or import and then release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming or importing any more numbers until 180 days past the oldest number released has expired. </para><para> For example, if you already have 99 claimed or imported numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services Support ticket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.PhoneNumberDescription"> <summary> <para> <para>The description of the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.SourcePhoneNumberArn"> <summary> <para> <para>The claimed phone number ARN being imported from the external service, such as Amazon Web Services End User Messaging. If it is from Amazon Web Services End User Messaging, it looks like the ARN of the phone number to import from Amazon Web Services End User Messaging.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.Select"> <summary> 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.ImportPhoneNumberResponse). Specifying the name of a property of type Amazon.Connect.Model.ImportPhoneNumberResponse 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.CONN.ImportCONNPhoneNumberCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ImportCONNPhoneNumberCmdlet.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.InvokeCONNPauseContactCmdlet"> <summary> Allows pausing an ongoing task contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNPauseContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNPauseContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNPauseContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the <c>instanceId</c> in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNPauseContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.PauseContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNPauseContactCmdlet.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.CONN.InvokeCONNPauseContactCmdlet.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.InvokeCONNResumeContactCmdlet"> <summary> Allows resuming a task contact in a paused state. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNResumeContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNResumeContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNResumeContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the <c>instanceId</c> in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNResumeContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ResumeContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.InvokeCONNResumeContactCmdlet.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.CONN.InvokeCONNResumeContactCmdlet.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.JoinCONNRoutingProfileQueueCmdlet"> <summary> Associates a set of queues with a routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.JoinCONNRoutingProfileQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.JoinCONNRoutingProfileQueueCmdlet.QueueConfig"> <summary> <para> <para>The queues to associate with this routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.JoinCONNRoutingProfileQueueCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.JoinCONNRoutingProfileQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.AssociateRoutingProfileQueuesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.JoinCONNRoutingProfileQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.JoinCONNRoutingProfileQueueCmdlet.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.MoveCONNContactCmdlet"> <summary> Transfers contacts from one agent or queue to another agent or queue at any point after a contact is created. You can transfer a contact to another queue by providing the flow which orchestrates the contact to the destination queue. This gives you more control over contact handling and helps you adhere to the service level agreement (SLA) guaranteed to your customers. <para> Note the following requirements: </para><ul><li><para> Transfer is supported for only <c>TASK</c> contacts. </para></li><li><para> Do not use both <c>QueueId</c> and <c>UserId</c> in the same call. </para></li><li><para> The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer to queue flow. </para></li><li><para> The <c>TransferContact</c> API can be called only on active contacts. </para></li><li><para> A contact cannot be transferred more than 11 times. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.UserId"> <summary> <para> <para>The identifier for the user. This can be the ID or the ARN of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.MoveCONNContactCmdlet.Select"> <summary> 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.TransferContactResponse). Specifying the name of a property of type Amazon.Connect.Model.TransferContactResponse 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.CONN.MoveCONNContactCmdlet.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.CONN.MoveCONNContactCmdlet.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.NewCONNAgentStatusCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Creates an agent status for the specified Amazon Connect instance. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.Description"> <summary> <para> <para>The description of the status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.DisplayOrder"> <summary> <para> <para>The display order of the status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.Name"> <summary> <para> <para>The name of the status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.State"> <summary> <para> <para>The state of the status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.Select"> <summary> 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.CreateAgentStatusResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateAgentStatusResponse 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.CONN.NewCONNAgentStatusCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNAgentStatusCmdlet.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.NewCONNContactCmdlet"> <summary> Creates a new contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.NewCONNContactCmdlet.Channel"> <summary> <para> <para>The channel for the contact</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.Description"> <summary> <para> <para>A description of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.ExpiryDurationInMinute"> <summary> <para> <para>Number of minutes the contact will be active for before expiring</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.InitiateAs"> <summary> <para> <para>Initial state of the contact when it's created</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.InitiationMethod"> <summary> <para> <para>Indicates how the contact was initiated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.Name"> <summary> <para> <para>The name of a the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.Reference"> <summary> <para> <para>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: URL | NUMBER | STRING | DATE | EMAIL | ATTACHMENT.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.RelatedContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.SegmentAttribute"> <summary> <para> <para>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</para><para>Attribute keys can include only alphanumeric, -, and _.</para><para>This field can be used to set Segment Contact Expiry as a duration in minutes.</para><note><para>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with <c>SegmentAttributes</c> like { <c> "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}</c>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.UserInfo_UserId"> <summary> <para> <para>The user identifier for the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.Select"> <summary> 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.CreateContactResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateContactResponse 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.CONN.NewCONNContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactCmdlet.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.NewCONNContactFlowCmdlet"> <summary> Creates a flow for the specified Amazon Connect instance. <para> You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect Flow language</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Content"> <summary> <para> <para>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example flow in Amazon Connect Flow language</a>. </para><para>Length Constraints: Minimum length of 1. Maximum length of 256000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Description"> <summary> <para> <para>The description of the flow. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Name"> <summary> <para> <para>The name of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Status"> <summary> <para> <para>Indicates the flow status as either <c>SAVED</c> or <c>PUBLISHED</c>. The <c>PUBLISHED</c> status will initiate validation on the content. the <c>SAVED</c> status does not initiate validation of the content. <c>SAVED</c> | <c>PUBLISHED</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Type"> <summary> <para> <para>The type of the flow. For descriptions of the available types, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types">Choose a flow type</a> in the <i>Amazon Connect Administrator Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.Select"> <summary> 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.CreateContactFlowResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateContactFlowResponse 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.CONN.NewCONNContactFlowCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowCmdlet.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.NewCONNContactFlowModuleCmdlet"> <summary> Creates a flow module for the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.Content"> <summary> <para> <para>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example flow in Amazon Connect Flow language</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.Description"> <summary> <para> <para>The description of the flow module. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.Name"> <summary> <para> <para>The name of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.Select"> <summary> 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.CreateContactFlowModuleResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateContactFlowModuleResponse 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.CONN.NewCONNContactFlowModuleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowModuleCmdlet.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.NewCONNContactFlowVersionCmdlet"> <summary> Publishes a new version of the flow provided. Versions are immutable and monotonically increasing. If a version of the same flow content already exists, no new version is created and instead the existing version number is returned. If the <c>FlowContentSha256</c> provided is different from the <c>FlowContentSha256</c> of the <c>$LATEST</c> published flow content, then an error is returned. This API only supports creating versions for flows of type <c>Campaign</c>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.Description"> <summary> <para> <para>The description of the flow version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.FlowContentSha256"> <summary> <para> <para>Indicates the checksum value of the flow content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.LastModifiedRegion"> <summary> <para> <para>The Amazon Web Services Region where this resource was last modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.LastModifiedTime"> <summary> <para> <para>The Amazon Web Services Region where this resource was last modified.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.Select"> <summary> 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.CreateContactFlowVersionResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateContactFlowVersionResponse 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.CONN.NewCONNContactFlowVersionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNContactFlowVersionCmdlet.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.NewCONNEmailAddressCmdlet"> <summary> Create new email address in the specified Amazon Connect instance. For more information about email addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html">Create email addresses</a> in the Amazon Connect Administrator Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.Description"> <summary> <para> <para>The description of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.DisplayName"> <summary> <para> <para>The display name of email address</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.EmailAddress"> <summary> <para> <para>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.Select"> <summary> 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.CreateEmailAddressResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateEmailAddressResponse 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.CONN.NewCONNEmailAddressCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEmailAddressCmdlet.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.NewCONNEvaluationFormCmdlet"> <summary> Creates an evaluation form in the specified Amazon Connect instance. The form can be used to define questions related to agent performance, and create sections to organize such questions. Question and section identifiers cannot be duplicated within the same evaluation form. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.Description"> <summary> <para> <para>The description of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.Item"> <summary> <para> <para>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.ScoringStrategy_Mode"> <summary> <para> <para>The scoring mode of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.ScoringStrategy_Status"> <summary> <para> <para>The scoring status of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.Title"> <summary> <para> <para>A title of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.Select"> <summary> 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.CreateEvaluationFormResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateEvaluationFormResponse 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.CONN.NewCONNEvaluationFormCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Title parameter. The -PassThru parameter is deprecated, use -Select '^Title' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNEvaluationFormCmdlet.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.NewCONNHoursOfOperationCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Creates hours of operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.Config"> <summary> <para> <para>Configuration information for the hours of operation: day, start time, and end time.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.Description"> <summary> <para> <para>The description of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.Name"> <summary> <para> <para>The name of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.TimeZone"> <summary> <para> <para>The time zone of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.Select"> <summary> 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.CreateHoursOfOperationResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateHoursOfOperationResponse 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.CONN.NewCONNHoursOfOperationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNHoursOfOperationCmdlet.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.NewCONNInstanceCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect. </para><para> For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-instances.html">Create an Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>. </para><para> Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.DirectoryId"> <summary> <para> <para>The identifier for the directory.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.IdentityManagementType"> <summary> <para> <para>The type of identity management for your Amazon Connect users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.InboundCallsEnabled"> <summary> <para> <para>Your contact center handles incoming contacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.InstanceAlias"> <summary> <para> <para>The name for your instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.OutboundCallsEnabled"> <summary> <para> <para>Your contact center allows outbound calls.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, <c>{ "tags": {"key1":"value1", "key2":"value2"} }</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.ClientToken"> <summary> <para> <para>The idempotency token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNInstanceCmdlet.Select"> <summary> 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.CreateInstanceResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateInstanceResponse 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.CONN.NewCONNInstanceCmdlet.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.NewCONNIntegrationAssociationCmdlet"> <summary> Creates an Amazon Web Services resource association with an Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.IntegrationArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the integration.</para><note><para>When integrating with Amazon Web Services End User Messaging, the Amazon Connect and Amazon Web Services End User Messaging instances must be in the same account.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.IntegrationType"> <summary> <para> <para>The type of information to be ingested.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.SourceApplicationName"> <summary> <para> <para>The name of the external application. This field is only required for the EVENT integration type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.SourceApplicationUrl"> <summary> <para> <para>The URL for the external application. This field is only required for the EVENT integration type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.SourceType"> <summary> <para> <para>The type of the data source. This field is only required for the EVENT integration type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.Select"> <summary> 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.CreateIntegrationAssociationResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateIntegrationAssociationResponse 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.CONN.NewCONNIntegrationAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNIntegrationAssociationCmdlet.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.NewCONNParticipantCmdlet"> <summary> Adds a new participant into an on-going chat contact. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-customize-flow.html">Customize chat flow experiences by integrating custom participants</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNParticipantCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. Only contacts in the CHAT channel are supported.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNParticipantCmdlet.ParticipantDetails_DisplayName"> <summary> <para> <para>The display name of the participant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNParticipantCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNParticipantCmdlet.ParticipantDetails_ParticipantRole"> <summary> <para> <para>The role of the participant being added.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNParticipantCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNParticipantCmdlet.Select"> <summary> 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.CreateParticipantResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateParticipantResponse 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.CONN.NewCONNParticipantCmdlet.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.CONN.NewCONNParticipantCmdlet.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.NewCONNPersistentContactAssociationCmdlet"> <summary> Enables rehydration of chats for the lifespan of a contact. For more information about chat rehydration, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html">Enable persistent chat</a> in the <i>Amazon Connect Administrator Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPersistentContactAssociationCmdlet.InitialContactId"> <summary> <para> <para>This is the contactId of the current contact that the <c>CreatePersistentContactAssociation</c> API is being called from.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPersistentContactAssociationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPersistentContactAssociationCmdlet.RehydrationType"> <summary> <para> <para>The contactId chosen for rehydration depends on the type chosen.</para><ul><li><para><c>ENTIRE_PAST_SESSION</c>: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the <c>initialContactId</c> of the past ended chat session in the <c>sourceContactId</c> field. In this type, Amazon Connect determines what the most recent chat contact on the past ended chat session and uses it to start a persistent chat. </para></li><li><para><c>FROM_SEGMENT</c>: Rehydrates a chat from the specified past chat contact provided in the <c>sourceContactId</c> field. </para></li></ul><para>The actual contactId used for rehydration is provided in the response of this API.</para><para>To illustrate how to use rehydration type, consider the following example: A customer starts a chat session. Agent a1 accepts the chat and a conversation starts between the customer and Agent a1. This first contact creates a contact ID <b>C1</b>. Agent a1 then transfers the chat to Agent a2. This creates another contact ID <b>C2</b>. At this point Agent a2 ends the chat. The customer is forwarded to the disconnect flow for a post chat survey that creates another contact ID <b>C3</b>. After the chat survey, the chat session ends. Later, the customer returns and wants to resume their past chat session. At this point, the customer can have following use cases: </para><ul><li><para><b>Use Case 1</b>: The customer wants to continue the past chat session but they want to hide the post chat survey. For this they will use the following configuration:</para><ul><li><para><b>Configuration</b></para><ul><li><para>SourceContactId = "C2"</para></li><li><para>RehydrationType = "FROM_SEGMENT"</para></li></ul></li><li><para><b>Expected behavior</b></para><ul><li><para>This starts a persistent chat session from the specified past ended contact (C2). Transcripts of past chat sessions C2 and C1 are accessible in the current persistent chat session. Note that chat segment C3 is dropped from the persistent chat session.</para></li></ul></li></ul></li><li><para><b>Use Case 2</b>: The customer wants to continue the past chat session and see the transcript of the entire past engagement, including the post chat survey. For this they will use the following configuration:</para><ul><li><para><b>Configuration</b></para><ul><li><para>SourceContactId = "C1"</para></li><li><para>RehydrationType = "ENTIRE_PAST_SESSION"</para></li></ul></li><li><para><b>Expected behavior</b></para><ul><li><para>This starts a persistent chat session from the most recently ended chat contact (C3). Transcripts of past chat sessions C3, C2 and C1 are accessible in the current persistent chat session.</para></li></ul></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPersistentContactAssociationCmdlet.SourceContactId"> <summary> <para> <para>The contactId from which a persistent chat session must be started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPersistentContactAssociationCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPersistentContactAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContinuedFromContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.CreatePersistentContactAssociationResponse). Specifying the name of a property of type Amazon.Connect.Model.CreatePersistentContactAssociationResponse 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.CONN.NewCONNPersistentContactAssociationCmdlet.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.NewCONNPredefinedAttributeCmdlet"> <summary> Creates a new predefined attribute for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPredefinedAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPredefinedAttributeCmdlet.Name"> <summary> <para> <para> The name of the predefined attribute. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPredefinedAttributeCmdlet.Values_StringList"> <summary> <para> <para>Predefined attribute values of type string list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPredefinedAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.CreatePredefinedAttributeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPredefinedAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPredefinedAttributeCmdlet.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.NewCONNPromptCmdlet"> <summary> Creates a prompt. For more information about prompts, such as supported file types and maximum length, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/prompts.html">Create prompts</a> in the <i>Amazon Connect Administrator Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.Description"> <summary> <para> <para>The description of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.Name"> <summary> <para> <para>The name of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.S3Uri"> <summary> <para> <para>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a> API instead of providing S3 URIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.Select"> <summary> 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.CreatePromptResponse). Specifying the name of a property of type Amazon.Connect.Model.CreatePromptResponse 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.CONN.NewCONNPromptCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNPromptCmdlet.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.NewCONNQueueCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Creates a new queue for the specified Amazon Connect instance. </para><important><ul><li><para> If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for <c>OutboundCallerIdNumberId</c>. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <c>ResourceNotFoundException</c>. </para></li><li><para> Only use the phone number ARN format that doesn't contain <c>instance</c> in the path, for example, <c>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</c>. This is the same ARN format that is returned when you call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> API. </para></li><li><para> If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region">Allow or Deny queue API actions for phone numbers in a replica Region</a>. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.Description"> <summary> <para> <para>The description of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.HoursOfOperationId"> <summary> <para> <para>The identifier for the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.MaxContact"> <summary> <para> <para>The maximum number of contacts that can be in the queue before it is considered full.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.Name"> <summary> <para> <para>The name of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.OutboundCallerConfig_OutboundCallerIdName"> <summary> <para> <para>The caller ID name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.OutboundCallerConfig_OutboundCallerIdNumberId"> <summary> <para> <para>The caller ID number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.OutboundEmailConfig_OutboundEmailAddressId"> <summary> <para> <para>The identifier of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.OutboundCallerConfig_OutboundFlowId"> <summary> <para> <para>The outbound whisper flow to be used during an outbound call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.QuickConnectId"> <summary> <para> <para>The quick connects available to agents who are working the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.Select"> <summary> 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.CreateQueueResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateQueueResponse 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.CONN.NewCONNQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQueueCmdlet.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.NewCONNQuickConnectCmdlet"> <summary> Creates a quick connect for the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.QueueConfig_ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.UserConfig_ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.Description"> <summary> <para> <para>The description of the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.Name"> <summary> <para> <para>A unique name of the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.PhoneConfig_PhoneNumber"> <summary> <para> <para>The phone number in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.QueueConfig_QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.QuickConnectConfig_QuickConnectType"> <summary> <para> <para>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.UserConfig_UserId"> <summary> <para> <para>The identifier of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.Select"> <summary> 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.CreateQuickConnectResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateQuickConnectResponse 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.CONN.NewCONNQuickConnectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNQuickConnectCmdlet.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.NewCONNRoutingProfileCmdlet"> <summary> Creates a new routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.AgentAvailabilityTimer"> <summary> <para> <para>Whether agents with this routing profile will have their routing order calculated based on <i>longest idle time</i> or <i>time since their last inbound contact</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.DefaultOutboundQueueId"> <summary> <para> <para>The default outbound queue for the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.Description"> <summary> <para> <para>Description of the routing profile. Must not be more than 250 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.MediaConcurrency"> <summary> <para> <para>The channels that agents can handle in the Contact Control Panel (CCP) for this routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.Name"> <summary> <para> <para>The name of the routing profile. Must not be more than 127 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.QueueConfig"> <summary> <para> <para>The inbound queues associated with the routing profile. If no queue is added, the agent can make only outbound calls.</para><para>The limit of 10 array members applies to the maximum number of <c>RoutingProfileQueueConfig</c> objects that can be passed during a CreateRoutingProfile API request. It is different from the quota of 50 queues per routing profile per instance that is listed in <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect service quotas</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.Select"> <summary> 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.CreateRoutingProfileResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateRoutingProfileResponse 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.CONN.NewCONNRoutingProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRoutingProfileCmdlet.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.NewCONNRuleCmdlet"> <summary> Creates a rule for the specified Amazon Connect instance. <para> Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.Action"> <summary> <para> <para>A list of actions to be run when the rule is triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.TriggerEventSource_EventSourceName"> <summary> <para> <para>The name of the event source.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.Function"> <summary> <para> <para>The conditions of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.TriggerEventSource_IntegrationAssociationId"> <summary> <para> <para>The identifier for the integration association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.Name"> <summary> <para> <para>A unique name for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.PublishStatus"> <summary> <para> <para>The publish status of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.Select"> <summary> 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.CreateRuleResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateRuleResponse 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.CONN.NewCONNRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNRuleCmdlet.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.NewCONNSecurityProfileCmdlet"> <summary> Creates a security profile. <para> For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.AllowedAccessControlHierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.AllowedAccessControlTag"> <summary> <para> <para>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.Application"> <summary> <para> <para>A list of third-party applications that the security profile will give access to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.Description"> <summary> <para> <para>The description of the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.HierarchyRestrictedResource"> <summary> <para> <para>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <c>User</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.Permission"> <summary> <para> <para>Permissions assigned to the security profile. For a list of valid permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.SecurityProfileName"> <summary> <para> <para>The name of the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.TagRestrictedResource"> <summary> <para> <para>The list of resources that a security profile applies tag restrictions to in Amazon Connect. Following are acceptable ResourceNames: <c>User</c> | <c>SecurityProfile</c> | <c>Queue</c> | <c>RoutingProfile</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.Select"> <summary> 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.CreateSecurityProfileResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateSecurityProfileResponse 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.CONN.NewCONNSecurityProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNSecurityProfileCmdlet.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.NewCONNTaskTemplateCmdlet"> <summary> Creates a new task template in the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow that runs by default when a task is created by referencing this template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Defaults_DefaultFieldValue"> <summary> <para> <para>Default value for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Description"> <summary> <para> <para>The description of the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Field"> <summary> <para> <para>Fields that are part of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Constraints_InvisibleField"> <summary> <para> <para>Lists the fields that are invisible to agents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Name"> <summary> <para> <para>The name of the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Constraints_ReadOnlyField"> <summary> <para> <para>Lists the fields that are read-only to agents, and cannot be edited.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Constraints_RequiredField"> <summary> <para> <para>Lists the fields that are required to be filled by agents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.SelfAssignFlowId"> <summary> <para> <para>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Status"> <summary> <para> <para>Marks a template as <c>ACTIVE</c> or <c>INACTIVE</c> for a task to refer to it. Tasks can only be created from <c>ACTIVE</c> templates. If a template is marked as <c>INACTIVE</c>, then a task that refers to this template cannot be created. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.Select"> <summary> 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.CreateTaskTemplateResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateTaskTemplateResponse 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.CONN.NewCONNTaskTemplateCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTaskTemplateCmdlet.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.NewCONNTrafficDistributionGroupCmdlet"> <summary> Creates a traffic distribution group given an Amazon Connect instance that has been replicated. <note><para> The <c>SignInConfig</c> distribution is available only on a default <c>TrafficDistributionGroup</c> (see the <c>IsDefault</c> parameter in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html">TrafficDistributionGroup</a> data type). If you call <c>UpdateTrafficDistribution</c> with a modified <c>SignInConfig</c> and a non-default <c>TrafficDistributionGroup</c>, an <c>InvalidRequestException</c> is returned. </para></note><para> For more information about creating traffic distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-traffic-distribution-groups.html">Set up traffic distribution groups</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.Description"> <summary> <para> <para>A description for the traffic distribution group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance that has been replicated. You can find the <c>instanceId</c> in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.Name"> <summary> <para> <para>The name for the traffic distribution group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.Select"> <summary> 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.CreateTrafficDistributionGroupResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateTrafficDistributionGroupResponse 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.CONN.NewCONNTrafficDistributionGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNTrafficDistributionGroupCmdlet.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.NewCONNUseCaseCmdlet"> <summary> Creates a use case for an integration association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUseCaseCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUseCaseCmdlet.IntegrationAssociationId"> <summary> <para> <para>The identifier for the integration association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUseCaseCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUseCaseCmdlet.UseCaseType"> <summary> <para> <para>The type of use case to associate to the integration association. Each integration association can have only one of each use case type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUseCaseCmdlet.Select"> <summary> 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.CreateUseCaseResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateUseCaseResponse 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.CONN.NewCONNUseCaseCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUseCaseCmdlet.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.NewCONNUserCmdlet"> <summary> Creates a user account for the specified Amazon Connect instance. <important><para> Certain <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UserIdentityInfo.html">UserIdentityInfo</a> parameters are required in some situations. For example, <c>Email</c> is required if you are using SAML for identity management. <c>FirstName</c> and <c>LastName</c> are required if you are using Amazon Connect or SAML for identity management. </para></important><para> For information about how to create users using the Amazon Connect admin website, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/user-management.html">Add Users</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.DirectoryUserId"> <summary> <para> <para>The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect cannot access the directory. Otherwise, the identity information is used to authenticate users from your 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 error is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.IdentityInfo"> <summary> <para> <para>The information about the identity of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Password"> <summary> <para> <para>The password for the user account. A password is required if you are using Amazon Connect for identity management. Otherwise, it is an error to include a password.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.PhoneConfig"> <summary> <para> <para>The phone settings for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.SecurityProfileId"> <summary> <para> <para>The identifier of the security profile for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Username"> <summary> <para> <para>The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+.</para><para>Username can include @ only if used in an email format. For example:</para><ul><li><para>Correct: testuser</para></li><li><para>Correct: testuser@example.com</para></li><li><para>Incorrect: testuser@example</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserCmdlet.Select"> <summary> 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.CreateUserResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateUserResponse 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.CONN.NewCONNUserCmdlet.PassThru"> <summary> 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. </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.NewCONNUserHierarchyGroupCmdlet"> <summary> Creates a new user hierarchy group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserHierarchyGroupCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserHierarchyGroupCmdlet.Name"> <summary> <para> <para>The name of the user hierarchy group. Must not be more than 100 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserHierarchyGroupCmdlet.ParentGroupId"> <summary> <para> <para>The identifier for the parent hierarchy group. The user hierarchy is created at level one if the parent group ID is null.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserHierarchyGroupCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserHierarchyGroupCmdlet.Select"> <summary> 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.CreateUserHierarchyGroupResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateUserHierarchyGroupResponse 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.CONN.NewCONNUserHierarchyGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNUserHierarchyGroupCmdlet.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.NewCONNViewCmdlet"> <summary> Creates a new view with the possible status of <c>SAVED</c> or <c>PUBLISHED</c>. <para> The views will have a unique name for each connect instance. </para><para> It performs basic content validation if the status is <c>SAVED</c> or full content validation if the status is set to <c>PUBLISHED</c>. An error is returned if validation fails. It associates either the <c>$SAVED</c> qualifier or both of the <c>$SAVED</c> and <c>$LATEST</c> qualifiers with the provided view content based on the status. The view is idempotent if ClientToken is provided. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Content_Action"> <summary> <para> <para>A list of possible actions from the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Description"> <summary> <para> <para>The description of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Name"> <summary> <para> <para>The name of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Status"> <summary> <para> <para>Indicates the view status as either <c>SAVED</c> or <c>PUBLISHED</c>. The <c>PUBLISHED</c> status will initiate validation on the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Tag"> <summary> <para> <para>The tags associated with the view resource (not specific to view version).These tags can be used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Content_Template"> <summary> <para> <para>The view template representing the structure of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.ClientToken"> <summary> <para> <para>A unique Id for each create view request to avoid duplicate view creation. For example, the view is idempotent ClientToken is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'View'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.CreateViewResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateViewResponse 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.CONN.NewCONNViewCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewCmdlet.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.NewCONNViewVersionCmdlet"> <summary> Publishes a new version of the view identifier. <para> Versions are immutable and monotonically increasing. </para><para> It returns the highest version if there is no change in content compared to that version. An error is displayed if the supplied ViewContentSha256 is different from the ViewContentSha256 of the <c>$LATEST</c> alias. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewVersionCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewVersionCmdlet.VersionDescription"> <summary> <para> <para>The description for the version being published.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewVersionCmdlet.ViewContentSha256"> <summary> <para> <para>Indicates the checksum value of the latest published view content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewVersionCmdlet.ViewId"> <summary> <para> <para>The identifier of the view. Both <c>ViewArn</c> and <c>ViewId</c> can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'View'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.CreateViewVersionResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateViewVersionResponse 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.CONN.NewCONNViewVersionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNViewVersionCmdlet.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.NewCONNVocabularyCmdlet"> <summary> Creates a custom vocabulary associated with your Amazon Connect instance. You can set a custom vocabulary to be your default vocabulary for a given language. Contact Lens for Amazon Connect uses the default vocabulary in post-call and real-time contact analysis sessions for that language. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.Content"> <summary> <para> <para>The content of the custom vocabulary in plain-text format with a table of values. Each row in the table represents a word or a phrase, described with <c>Phrase</c>, <c>IPA</c>, <c>SoundsLike</c>, and <c>DisplayAs</c> fields. Separate the fields with TAB characters. The size limit is 50KB. For more information, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table">Create a custom vocabulary using a table</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.VocabularyName"> <summary> <para> <para>A unique name of the custom vocabulary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. If a create request is received more than once with same client token, subsequent requests return the previous response without creating a vocabulary again.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.Select"> <summary> 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.CreateVocabularyResponse). Specifying the name of a property of type Amazon.Connect.Model.CreateVocabularyResponse 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.CONN.NewCONNVocabularyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Content parameter. The -PassThru parameter is deprecated, use -Select '^Content' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.NewCONNVocabularyCmdlet.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.RegisterCONNAnalyticsDataSetCmdlet"> <summary> Associates the specified dataset for a Amazon Connect instance with the target account. You can associate only one dataset in a single call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNAnalyticsDataSetCmdlet.DataSetId"> <summary> <para> <para>The identifier of the dataset to associate with the target account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNAnalyticsDataSetCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNAnalyticsDataSetCmdlet.TargetAccountId"> <summary> <para> <para>The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNAnalyticsDataSetCmdlet.Select"> <summary> 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.AssociateAnalyticsDataSetResponse). Specifying the name of a property of type Amazon.Connect.Model.AssociateAnalyticsDataSetResponse 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.CONN.RegisterCONNAnalyticsDataSetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNAnalyticsDataSetCmdlet.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.RegisterCONNBatchAnalyticsDataSetCmdlet"> <summary> Associates a list of analytics datasets for a given Amazon Connect instance to a target account. You can associate multiple datasets in a single call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNBatchAnalyticsDataSetCmdlet.DataSetId"> <summary> <para> <para>An array of dataset identifiers to associate.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNBatchAnalyticsDataSetCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNBatchAnalyticsDataSetCmdlet.TargetAccountId"> <summary> <para> <para>The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNBatchAnalyticsDataSetCmdlet.Select"> <summary> 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.BatchAssociateAnalyticsDataSetResponse). Specifying the name of a property of type Amazon.Connect.Model.BatchAssociateAnalyticsDataSetResponse 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.CONN.RegisterCONNBatchAnalyticsDataSetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RegisterCONNBatchAnalyticsDataSetCmdlet.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.RemoveCONNApprovedOriginCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Revokes access to integrated applications from Amazon Connect. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNApprovedOriginCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNApprovedOriginCmdlet.Origin"> <summary> <para> <para>The domain URL of the integrated application.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNApprovedOriginCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateApprovedOriginResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNApprovedOriginCmdlet.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.RemoveCONNAttachedFileCmdlet"> <summary> Deletes an attached file along with the underlying S3 Object. <important><para> The attached file is <b>permanently deleted</b> if S3 bucket versioning is not enabled. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNAttachedFileCmdlet.AssociatedResourceArn"> <summary> <para> <para>The resource to which the attached file is (being) uploaded to. <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Cases</a> are the only current supported resource.</para><note><para>This value must be a valid ARN.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNAttachedFileCmdlet.FileId"> <summary> <para> <para>The unique identifier of the attached file resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNAttachedFileCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNAttachedFileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteAttachedFileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNAttachedFileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AssociatedResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^AssociatedResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNAttachedFileCmdlet.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.RemoveCONNBotCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Revokes authorization from the specified instance to access the specified Amazon Lex or Amazon Lex V2 bot. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.LexV2Bot_AliasArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.LexBot_LexRegion"> <summary> <para> <para>The Amazon Web Services Region where the Amazon Lex bot was created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.LexBot_Name"> <summary> <para> <para>The name of the Amazon Lex bot.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateBotResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNBotCmdlet.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.RemoveCONNContactEvaluationCmdlet"> <summary> Deletes a contact evaluation in the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactEvaluationCmdlet.EvaluationId"> <summary> <para> <para>A unique identifier for the contact evaluation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactEvaluationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactEvaluationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteContactEvaluationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactEvaluationCmdlet.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.RemoveCONNContactFlowCmdlet"> <summary> Deletes a flow for the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteContactFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowCmdlet.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.RemoveCONNContactFlowModuleCmdlet"> <summary> Deletes the specified flow module. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowModuleCmdlet.ContactFlowModuleId"> <summary> <para> <para>The identifier of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowModuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowModuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteContactFlowModuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowModuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowModuleId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowModuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactFlowModuleCmdlet.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.RemoveCONNContactTagCmdlet"> <summary> Removes the specified tags from the contact resource. For more information about this API is used, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/granular-billing.html">Set up granular billing for a detailed view of your Amazon Connect usage</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactTagCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactTagCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactTagCmdlet.TagKey"> <summary> <para> <para>A list of tag keys. Existing tags on the contact whose keys are members of this list will be removed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UntagContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNContactTagCmdlet.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.CONN.RemoveCONNContactTagCmdlet.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.RemoveCONNEmailAddressCmdlet"> <summary> Deletes email address from the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEmailAddressCmdlet.EmailAddressId"> <summary> <para> <para>The identifier of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEmailAddressCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEmailAddressCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteEmailAddressResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEmailAddressCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEmailAddressCmdlet.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.RemoveCONNEvaluationFormCmdlet"> <summary> Deletes an evaluation form in the specified Amazon Connect instance. <ul><li><para> If the version property is provided, only the specified version of the evaluation form is deleted. </para></li><li><para> If no version is provided, then the full form (all versions) is deleted. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEvaluationFormCmdlet.EvaluationFormId"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEvaluationFormCmdlet.EvaluationFormVersion"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEvaluationFormCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEvaluationFormCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteEvaluationFormResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEvaluationFormCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNEvaluationFormCmdlet.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.RemoveCONNFlowCmdlet"> <summary> Disassociates a connect resource from a flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNFlowCmdlet.ResourceId"> <summary> <para> <para>The identifier of the resource.</para><ul><li><para>Amazon Web Services End User Messaging SMS phone number ARN when using <c>SMS_PHONE_NUMBER</c></para></li><li><para>Amazon Web Services End User Messaging Social phone number ARN when using <c>WHATSAPP_MESSAGING_PHONE_NUMBER</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNFlowCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNFlowCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNFlowCmdlet.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.RemoveCONNHoursOfOperationCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Deletes an hours of operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNHoursOfOperationCmdlet.HoursOfOperationId"> <summary> <para> <para>The identifier for the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNHoursOfOperationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNHoursOfOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteHoursOfOperationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNHoursOfOperationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNHoursOfOperationCmdlet.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.RemoveCONNInstanceCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Deletes the Amazon Connect instance. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-connect-instance.html">Delete your Amazon Connect instance</a> in the <i>Amazon Connect Administrator Guide</i>. </para><para> Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteInstanceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceCmdlet.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.RemoveCONNInstanceStorageConfigCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Removes the storage type configurations for the specified resource type and association ID. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceStorageConfigCmdlet.AssociationId"> <summary> <para> <para>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceStorageConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceStorageConfigCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceStorageConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateInstanceStorageConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNInstanceStorageConfigCmdlet.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.RemoveCONNIntegrationAssociationCmdlet"> <summary> Deletes an Amazon Web Services resource association from an Amazon Connect instance. The association must not have any use cases associated with it. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNIntegrationAssociationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNIntegrationAssociationCmdlet.IntegrationAssociationId"> <summary> <para> <para>The identifier for the integration association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNIntegrationAssociationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteIntegrationAssociationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNIntegrationAssociationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNIntegrationAssociationCmdlet.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.RemoveCONNLambdaFunctionCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Remove the Lambda function from the dropdown options available in the relevant flow blocks. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLambdaFunctionCmdlet.FunctionArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the Lambda function being disassociated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLambdaFunctionCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance..</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLambdaFunctionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateLambdaFunctionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLambdaFunctionCmdlet.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.RemoveCONNLexBotCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Revokes authorization from the specified instance to access the specified Amazon Lex bot. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLexBotCmdlet.BotName"> <summary> <para> <para>The name of the Amazon Lex bot. Maximum character limit of 50.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLexBotCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLexBotCmdlet.LexRegion"> <summary> <para> <para>The Amazon Web Services Region in which the Amazon Lex bot has been created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLexBotCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateLexBotResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNLexBotCmdlet.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.RemoveCONNPhoneNumberCmdlet"> <summary> Releases a phone number previously claimed to an Amazon Connect instance or traffic distribution group. You can call this API only in the Amazon Web Services Region where the number was claimed. <important><para> To release phone numbers from a traffic distribution group, use the <c>ReleasePhoneNumber</c> API, not the Amazon Connect admin website. </para><para> After releasing a phone number, the phone number enters into a cooldown period for up to 180 days. It cannot be searched for or claimed again until the period has ended. If you accidentally release a phone number, contact Amazon Web Services Support. </para></important><para> If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. </para><para> By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. </para><para> For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>A unique identifier for the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ReleasePhoneNumberResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberCmdlet.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.RemoveCONNPhoneNumberContactFlowCmdlet"> <summary> Removes the flow association from a phone number claimed to your Amazon Connect instance. <important><para> If the number is claimed to a traffic distribution group, and you are calling this API using an instance in the Amazon Web Services Region where the traffic distribution group was created, you can use either a full phone number ARN or UUID value for the <c>PhoneNumberId</c> URI request parameter. However, if the number is claimed to a traffic distribution group and you are calling this API using an instance in the alternate Amazon Web Services Region associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <c>ResourceNotFoundException</c>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberContactFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberContactFlowCmdlet.PhoneNumberId"> <summary> <para> <para>A unique identifier for the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberContactFlowCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociatePhoneNumberContactFlowResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberContactFlowCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPhoneNumberContactFlowCmdlet.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.RemoveCONNPredefinedAttributeCmdlet"> <summary> Deletes a predefined attribute from the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPredefinedAttributeCmdlet.InstanceId"> <summary> <para> <para> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPredefinedAttributeCmdlet.Name"> <summary> <para> <para> The name of the predefined attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPredefinedAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeletePredefinedAttributeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPredefinedAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPredefinedAttributeCmdlet.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.RemoveCONNPromptCmdlet"> <summary> Deletes a prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPromptCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPromptCmdlet.PromptId"> <summary> <para> <para>A unique identifier for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPromptCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeletePromptResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPromptCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNPromptCmdlet.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.RemoveCONNQueueCmdlet"> <summary> Deletes a queue. It isn't possible to delete a queue by using the Amazon Connect admin website. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteQueueResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueCmdlet.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.RemoveCONNQueueQuickConnectCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Disassociates a set of quick connects from a queue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueQuickConnectCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueQuickConnectCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueQuickConnectCmdlet.QuickConnectId"> <summary> <para> <para>The quick connects to disassociate from the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueQuickConnectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateQueueQuickConnectsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueQuickConnectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQueueQuickConnectCmdlet.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.RemoveCONNQuickConnectCmdlet"> <summary> Deletes a quick connect. <important><para> After calling <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteUser.html">DeleteUser</a>, it's important to call <c>DeleteQuickConnect</c> to delete any records related to the deleted users. This will help you: </para><ul><li><para> Avoid dangling resources that impact your service quotas. </para></li><li><para> Remove deleted users so they don't appear to agents as transfer options. </para></li><li><para> Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Amazon Connect Global Resiliency</a>. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQuickConnectCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQuickConnectCmdlet.QuickConnectId"> <summary> <para> <para>The identifier for the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQuickConnectCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteQuickConnectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQuickConnectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNQuickConnectCmdlet.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.RemoveCONNResourceTagCmdlet"> <summary> Removes the specified tags from the specified resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNResourceTagCmdlet.ResourceArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNResourceTagCmdlet.TagKey"> <summary> <para> <para>The tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNResourceTagCmdlet.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.RemoveCONNRoutingProfileCmdlet"> <summary> Deletes a routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRoutingProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRoutingProfileCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRoutingProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteRoutingProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRoutingProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRoutingProfileCmdlet.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.RemoveCONNRuleCmdlet"> <summary> Deletes a rule for the specified Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRuleCmdlet.RuleId"> <summary> <para> <para>A unique identifier for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleId parameter. The -PassThru parameter is deprecated, use -Select '^RuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNRuleCmdlet.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.RemoveCONNSecurityKeyCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Deletes the specified security key. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityKeyCmdlet.AssociationId"> <summary> <para> <para>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityKeyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityKeyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateSecurityKeyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityKeyCmdlet.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.RemoveCONNSecurityProfileCmdlet"> <summary> Deletes a security profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityProfileCmdlet.SecurityProfileId"> <summary> <para> <para>The identifier for the security profle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteSecurityProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SecurityProfileId parameter. The -PassThru parameter is deprecated, use -Select '^SecurityProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNSecurityProfileCmdlet.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.RemoveCONNTaskTemplateCmdlet"> <summary> Deletes the task template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTaskTemplateCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTaskTemplateCmdlet.TaskTemplateId"> <summary> <para> <para>A unique identifier for the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTaskTemplateCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteTaskTemplateResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTaskTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskTemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TaskTemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTaskTemplateCmdlet.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.RemoveCONNTrafficDistributionGroupCmdlet"> <summary> Deletes a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. <para> For more information about deleting traffic distribution groups, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-traffic-distribution-groups.html">Delete traffic distribution groups</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupCmdlet.TrafficDistributionGroupId"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteTrafficDistributionGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrafficDistributionGroupId parameter. The -PassThru parameter is deprecated, use -Select '^TrafficDistributionGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupCmdlet.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.RemoveCONNTrafficDistributionGroupUserCmdlet"> <summary> Disassociates an agent from a traffic distribution group. This API can be called only in the Region where the traffic distribution group is created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupUserCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupUserCmdlet.TrafficDistributionGroupId"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN of the traffic distribution group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupUserCmdlet.UserId"> <summary> <para> <para>The identifier for the user. This can be the ID or the ARN of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateTrafficDistributionGroupUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TrafficDistributionGroupId parameter. The -PassThru parameter is deprecated, use -Select '^TrafficDistributionGroupId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNTrafficDistributionGroupUserCmdlet.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.RemoveCONNUseCaseCmdlet"> <summary> Deletes a use case from an integration association. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUseCaseCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUseCaseCmdlet.IntegrationAssociationId"> <summary> <para> <para>The identifier for the integration association.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUseCaseCmdlet.UseCaseId"> <summary> <para> <para>The identifier for the use case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUseCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteUseCaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUseCaseCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUseCaseCmdlet.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 the specified Amazon Connect instance. <para> For information about what happens to a user's data when their account is deleted, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/delete-users.html">Delete Users from Your Amazon Connect Instance</a> in the <i>Amazon Connect Administrator Guide</i>. </para><important><para> After calling DeleteUser, call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteQuickConnect.html">DeleteQuickConnect</a> to delete any records related to the deleted users. This will help you: </para><ul><li><para> Avoid dangling resources that impact your service quotas. </para></li><li><para> Remove deleted users so they don't appear to agents as transfer options. </para></li><li><para> Avoid the disruption of other Amazon Connect processes, such as instance replication and syncing if you're using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-connect-global-resiliency.html">Amazon Connect Global Resiliency</a>. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.UserId"> <summary> <para> <para>The identifier of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteUserResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </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.RemoveCONNUserHierarchyGroupCmdlet"> <summary> Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserHierarchyGroupCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserHierarchyGroupCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserHierarchyGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteUserHierarchyGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserHierarchyGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserHierarchyGroupCmdlet.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.RemoveCONNUserProficiencyCmdlet"> <summary> Disassociates a set of proficiencies from a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserProficiencyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserProficiencyCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserProficiencyCmdlet.UserProficiency"> <summary> <para> <para>The proficiencies to disassociate from the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserProficiencyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateUserProficienciesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserProficiencyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNUserProficiencyCmdlet.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.RemoveCONNViewCmdlet"> <summary> Deletes the view entirely. It deletes the view and all associated qualifiers (versions and aliases). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewCmdlet.ViewId"> <summary> <para> <para>The identifier of the view. Both <c>ViewArn</c> and <c>ViewId</c> can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteViewResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewCmdlet.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.RemoveCONNViewVersionCmdlet"> <summary> Deletes the particular version specified in <c>ViewVersion</c> identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewVersionCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewVersionCmdlet.ViewId"> <summary> <para> <para>The identifier of the view. Both <c>ViewArn</c> and <c>ViewId</c> can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewVersionCmdlet.ViewVersion"> <summary> <para> <para>The version number of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewVersionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DeleteViewVersionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewVersionCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNViewVersionCmdlet.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.RemoveCONNVocabularyCmdlet"> <summary> Deletes the vocabulary that has the given identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNVocabularyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNVocabularyCmdlet.VocabularyId"> <summary> <para> <para>The identifier of the custom vocabulary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNVocabularyCmdlet.Select"> <summary> 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.DeleteVocabularyResponse). Specifying the name of a property of type Amazon.Connect.Model.DeleteVocabularyResponse 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.CONN.RemoveCONNVocabularyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RemoveCONNVocabularyCmdlet.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.RequestCONNPhoneNumberCmdlet"> <summary> Claims an available phone number to your Amazon Connect instance or traffic distribution group. You can call this API only in the same Amazon Web Services Region where the Amazon Connect instance or traffic distribution group was created. <para> For more information about how to use this operation, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-number.html">Claim a phone number in your country</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/claim-phone-numbers-traffic-distribution-groups.html">Claim phone numbers to traffic distribution groups</a> in the <i>Amazon Connect Administrator Guide</i>. </para><important><para> You can call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_SearchAvailablePhoneNumbers.html">SearchAvailablePhoneNumbers</a> API for available phone numbers that you can claim. Call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API to verify the status of a previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html">ClaimPhoneNumber</a> operation. </para></important><para> If you plan to claim and release numbers frequently, contact us for a service quota exception. Otherwise, it is possible you will be blocked from claiming and releasing any more numbers until up to 180 days past the oldest number released has expired. </para><para> By default you can claim and release up to 200% of your maximum number of active phone numbers. If you claim and release phone numbers using the UI or API during a rolling 180 day cycle that exceeds 200% of your phone number service level quota, you will be blocked from claiming any more numbers until 180 days past the oldest number released has expired. </para><para> For example, if you already have 99 claimed numbers and a service level quota of 99 phone numbers, and in any 180 day period you release 99, claim 99, and then release 99, you will have exceeded the 200% limit. At that point you are blocked from claiming any more numbers until you open an Amazon Web Services support ticket. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <c>InstanceId</c> or <c>TargetArn</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.PhoneNumber"> <summary> <para> <para>The phone number you want to claim. Phone numbers are formatted <c>[+] [country code] [subscriber number including area code]</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.PhoneNumberDescription"> <summary> <para> <para>The description of the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.TargetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <c>InstanceId</c> or <c>TargetArn</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para><para>Pattern: <c>^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.Select"> <summary> 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.ClaimPhoneNumberResponse). Specifying the name of a property of type Amazon.Connect.Model.ClaimPhoneNumberResponse 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.CONN.RequestCONNPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumber parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumber' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.RequestCONNPhoneNumberCmdlet.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.ResumeCONNContactRecordingCmdlet"> <summary> When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume. <para> Voice and screen recordings are supported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.ContactRecordingType"> <summary> <para> <para>The type of recording being operated on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.InitialContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.ResumeContactRecordingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.ResumeCONNContactRecordingCmdlet.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.SearchCONNAgentStatusCmdlet"> <summary> Searches AgentStatuses in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNAgentStatusCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A leaf node condition which can be used to specify a string condition.</para><note><para>The currently supported values for <c>FieldName</c> are <c>name</c>, <c>description</c>, <c>state</c>, <c>type</c>, <c>displayOrder</c>, and <c>resourceID</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.AttributeFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.AndCondition_TagCondition"> <summary> <para> <para>A leaf node condition which can be used to specify a tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.SearchFilter_AttributeFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.SearchFilter_AttributeFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.Select"> <summary> 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.SearchAgentStatusesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchAgentStatusesResponse 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.CONN.SearchCONNAgentStatusCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAgentStatusCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet"> <summary> Searches for available phone numbers that you can claim to your Amazon Connect instance or traffic distribution group. If the provided <c>TargetArn</c> is a traffic distribution group, you can call this API in both Amazon Web Services Regions associated with the traffic distribution group.<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.CONN.SearchCONNAvailablePhoneNumberCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <c>InstanceId</c> or <c>TargetArn</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.PhoneNumberCountryCode"> <summary> <para> <para>The ISO country code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.PhoneNumberPrefix"> <summary> <para> <para>The prefix of the phone number. If provided, it must contain <c>+</c> as part of the country code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.PhoneNumberType"> <summary> <para> <para>The type of phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.TargetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <c>InstanceId</c> or <c>TargetArn</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AvailableNumbersList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.SearchAvailablePhoneNumbersResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchAvailablePhoneNumbersResponse 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.CONN.SearchCONNAvailablePhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TargetArn parameter. The -PassThru parameter is deprecated, use -Select '^TargetArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNAvailablePhoneNumberCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet"> <summary> Searches contacts in an Amazon Connect instance.<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.CONN.SearchCONNContactCmdlet.SearchCriteria_AgentId"> <summary> <para> <para>The identifiers of agents who handled the contacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchCriteria_Channel"> <summary> <para> <para>The list of channels associated with contacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.Transcript_Criterion"> <summary> <para> <para>The list of search criteria based on Contact Lens conversational analytics transcript.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchableContactAttributes_Criterion"> <summary> <para> <para>The list of criteria based on user-defined contact attributes that are configured for contact search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchableSegmentAttributes_Criterion"> <summary> <para> <para>The list of criteria based on searchable segment attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.TimeRange_EndTime"> <summary> <para> <para>The end time of the time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.Sort_FieldName"> <summary> <para> <para>The name of the field on which to sort.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchCriteria_InitiationMethod"> <summary> <para> <para>The list of initiation methods associated with contacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.AgentHierarchyGroups_L1Id"> <summary> <para> <para>The identifiers for level 1 hierarchy groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.AgentHierarchyGroups_L2Id"> <summary> <para> <para>The identifiers for level 2 hierarchy groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.AgentHierarchyGroups_L3Id"> <summary> <para> <para>The identifiers for level 3 hierarchy groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.AgentHierarchyGroups_L4Id"> <summary> <para> <para>The identifiers for level 4 hierarchy groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.AgentHierarchyGroups_L5Id"> <summary> <para> <para>The identifiers for level 5 hierarchy groups.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.Transcript_MatchType"> <summary> <para> <para>The match type combining search criteria using multiple transcript criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchableContactAttributes_MatchType"> <summary> <para> <para>The match type combining search criteria using multiple searchable contact attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchableSegmentAttributes_MatchType"> <summary> <para> <para>The match type combining search criteria using multiple searchable segment attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.Sort_Order"> <summary> <para> <para>An ascending or descending sort.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.SearchCriteria_QueueId"> <summary> <para> <para>The list of queue IDs associated with contacts.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.TimeRange_StartTime"> <summary> <para> <para>The start time of the time range.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.TimeRange_Type"> <summary> <para> <para>The type of timestamp to search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet"> <summary> Searches the flows in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNContactFlowCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.SearchCriteria_StateCondition"> <summary> <para> <para>The state of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.SearchCriteria_StatusCondition"> <summary> <para> <para>The status of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.SearchCriteria_TypeCondition"> <summary> <para> <para>The type of flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.Select"> <summary> 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.SearchContactFlowsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchContactFlowsResponse 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.CONN.SearchCONNContactFlowCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet"> <summary> Searches the flow modules in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNContactFlowModuleCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.Select"> <summary> 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.SearchContactFlowModulesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchContactFlowModulesResponse 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.CONN.SearchCONNContactFlowModuleCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNContactFlowModuleCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet"> <summary> Searches email address in an instance, with optional filtering.<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.CONN.SearchCONNEmailAddressCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.Select"> <summary> 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.SearchEmailAddressesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchEmailAddressesResponse 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.CONN.SearchCONNEmailAddressCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNEmailAddressCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet"> <summary> Searches the hours of operation in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNHoursOfOperationCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.Select"> <summary> 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.SearchHoursOfOperationsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchHoursOfOperationsResponse 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.CONN.SearchCONNHoursOfOperationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNHoursOfOperationCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet"> <summary> Searches predefined attributes that meet certain criteria. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>.<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.CONN.SearchCONNPredefinedAttributeCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.Select"> <summary> 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.SearchPredefinedAttributesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchPredefinedAttributesResponse 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.CONN.SearchCONNPredefinedAttributeCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPredefinedAttributeCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet"> <summary> Searches prompts in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNPromptCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.Select"> <summary> 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.SearchPromptsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchPromptsResponse 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.CONN.SearchCONNPromptCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNPromptCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet"> <summary> Searches queues in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNQueueCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.SearchCriteria_QueueTypeCondition"> <summary> <para> <para>The type of queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.Select"> <summary> 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.SearchQueuesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchQueuesResponse 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.CONN.SearchCONNQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQueueCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet"> <summary> Searches quick connects in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNQuickConnectCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.Select"> <summary> 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.SearchQuickConnectsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchQuickConnectsResponse 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.CONN.SearchCONNQuickConnectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNQuickConnectCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet"> <summary> Searches tags used in an Amazon Connect instance using optional search criteria.<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.CONN.SearchCONNResourceTagCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.ResourceType"> <summary> <para> <para>The list of resource types to be used to search tags from. If not provided or if any empty list is provided, this API will search from all supported resource types.</para><para><b>Supported resource types</b></para><ul><li><para>AGENT</para></li><li><para>ROUTING_PROFILE</para></li><li><para>STANDARD_QUEUE</para></li><li><para>SECURITY_PROFILE</para></li><li><para>OPERATING_HOURS</para></li><li><para>PROMPT</para></li><li><para>CONTACT_FLOW</para></li><li><para>FLOW_MODULE</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.TagSearchCondition_TagKey"> <summary> <para> <para>The tag key used in the tag search condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.TagSearchCondition_TagKeyComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the tag key in tag search condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.TagSearchCondition_TagValue"> <summary> <para> <para>The tag value used in the tag search condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.TagSearchCondition_TagValueComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the tag value in tag search condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Tags'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.SearchResourceTagsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchResourceTagsResponse 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.CONN.SearchCONNResourceTagCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNResourceTagCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet"> <summary> Searches routing profiles in an Amazon Connect instance, with optional filtering.<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.CONN.SearchCONNRoutingProfileCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.Select"> <summary> 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.SearchRoutingProfilesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchRoutingProfilesResponse 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.CONN.SearchCONNRoutingProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNRoutingProfileCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet"> <summary> Searches security profiles in an Amazon Connect instance, with optional filtering. <para> For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para><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.CONN.SearchCONNSecurityProfileCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.Select"> <summary> 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.SearchSecurityProfilesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchSecurityProfilesResponse 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.CONN.SearchCONNSecurityProfileCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNSecurityProfileCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet"> <summary> Searches users in an Amazon Connect instance, with optional filtering. <note><para><c>AfterContactWorkTimeLimit</c> is returned in milliseconds. </para></note><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.CONN.SearchCONNUserCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.TagFilter_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>AND</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.ListCondition_Condition"> <summary> <para> <para>A list of Condition objects which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.HierarchyGroupCondition_HierarchyGroupMatchType"> <summary> <para> <para>The type of hierarchy group match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchFilter_UserAttributeFilter_AndCondition_HierarchyGroupCondition_HierarchyGroupMatchType"> <summary> <para> <para>The type of hierarchy group match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchFilter_UserAttributeFilter_HierarchyGroupCondition_HierarchyGroupMatchType"> <summary> <para> <para>The type of hierarchy group match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para><note><para>InstanceID is a required field. The "Required: No" below is incorrect.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.TagFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.UserAttributeFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.AndCondition_TagCondition"> <summary> <para> <para>A leaf node condition which can be used to specify a tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchFilter_TagFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchFilter_TagFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.ListCondition_TargetListType"> <summary> <para> <para>The type of target list that will be used to filter the users.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.HierarchyGroupCondition_Value"> <summary> <para> <para>The value in the hierarchy group condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchFilter_UserAttributeFilter_AndCondition_HierarchyGroupCondition_Value"> <summary> <para> <para>The value in the hierarchy group condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.SearchFilter_UserAttributeFilter_HierarchyGroupCondition_Value"> <summary> <para> <para>The value in the hierarchy group condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.Select"> <summary> 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.SearchUsersResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchUsersResponse 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.CONN.SearchCONNUserCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet"> <summary> Searches UserHierarchyGroups in an Amazon Connect instance, with optional filtering. <important><para> The UserHierarchyGroup with <c>"LevelId": "0"</c> is the foundation for building levels on top of an instance. It is not user-definable, nor is it visible in the UI. </para></important><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.CONN.SearchCONNUserHierarchyGroupCmdlet.SearchCriteria_AndCondition"> <summary> <para> <para>A list of conditions which would be applied together with an AND condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.StringCondition_ComparisonType"> <summary> <para> <para>The type of comparison to be made when evaluating the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.StringCondition_FieldName"> <summary> <para> <para>The name of the field in the string condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.SearchCriteria_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an OR condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.AttributeFilter_OrCondition"> <summary> <para> <para>A list of conditions which would be applied together with an <c>OR</c> condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.AndCondition_TagCondition"> <summary> <para> <para>A leaf node condition which can be used to specify a tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.SearchFilter_AttributeFilter_TagCondition_TagKey"> <summary> <para> <para>The tag key in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.SearchFilter_AttributeFilter_TagCondition_TagValue"> <summary> <para> <para>The tag value in the tag condition.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.StringCondition_Value"> <summary> <para> <para>The value of the string.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.Select"> <summary> 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.SearchUserHierarchyGroupsResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchUserHierarchyGroupsResponse 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.CONN.SearchCONNUserHierarchyGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNUserHierarchyGroupCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet"> <summary> Searches for vocabularies within a specific Amazon Connect instance using <c>State</c>, <c>NameStartsWith</c>, and <c>LanguageCode</c>.<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.CONN.SearchCONNVocabularyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.LanguageCode"> <summary> <para> <para>The language code of the vocabulary entries. For a list of languages and their corresponding language codes, see <a href="https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html">What is Amazon Transcribe?</a></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.NameStartsWith"> <summary> <para> <para>The starting pattern of the name of the vocabulary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.State"> <summary> <para> <para>The current state of the custom vocabulary.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.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/>'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. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'VocabularySummaryList'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.SearchVocabulariesResponse). Specifying the name of a property of type Amazon.Connect.Model.SearchVocabulariesResponse 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.CONN.SearchCONNVocabularyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.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="P:Amazon.PowerShell.Cmdlets.CONN.SearchCONNVocabularyCmdlet.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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet"> <summary> Processes chat integration events from Amazon Web Services or external integrations to Amazon Connect. A chat integration event includes: <ul><li><para> SourceId, DestinationId, and Subtype: a set of identifiers, uniquely representing a chat </para></li><li><para> ChatEvent: details of the chat action to perform such as sending a message, event, or disconnecting from a chat </para></li></ul><para> When a chat integration event is sent with chat identifiers that do not map to an active chat contact, a new chat contact is also created before handling chat action. </para><para> Access to this API is currently restricted to Amazon Web Services End User Messaging for supporting SMS integration. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.NewSessionDetails_Attribute"> <summary> <para> <para> A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in 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.SendCONNChatIntegrationEventCmdlet.Event_Content"> <summary> <para> <para>Content of the message or event. This is required when <c>Type</c> is <c>MESSAGE</c> and for certain <c>ContentTypes</c> when <c>Type</c> is <c>EVENT</c>.</para><ul><li><para>For allowed message content, see the <c>Content</c> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic in the <i>Amazon Connect Participant Service API Reference</i>.</para></li><li><para>For allowed event content, see the <c>Content</c> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html">SendEvent</a> topic in the <i>Amazon Connect Participant Service API Reference</i>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.Event_ContentType"> <summary> <para> <para>Type of content. This is required when <c>Type</c> is <c>MESSAGE</c> or <c>EVENT</c>. </para><ul><li><para>For allowed message content types, see the <c>ContentType</c> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html">SendMessage</a> topic in the <i>Amazon Connect Participant Service API Reference</i>.</para></li><li><para>For allowed event content types, see the <c>ContentType</c> parameter in the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html">SendEvent</a> topic in the <i>Amazon Connect Participant Service API Reference</i>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.DestinationId"> <summary> <para> <para>Chat system identifier, used in part to uniquely identify chat. This is associated with the Amazon Connect instance and flow to be used to start chats. For Server Migration Service, this is the phone number destination of inbound Server Migration Service messages represented by an Amazon Web Services End User Messaging phone number ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.ParticipantDetails_DisplayName"> <summary> <para> <para>Display name of the participant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.SourceId"> <summary> <para> <para>External identifier of chat customer participant, used in part to uniquely identify a chat. For SMS, this is the E164 phone number of the chat customer participant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.StreamingConfiguration_StreamingEndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.Subtype"> <summary> <para> <para>Classification of a channel. This is used in part to uniquely identify chat. </para><para>Valid value: <c>["connect:sms", connect:"WhatsApp"]</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.NewSessionDetails_SupportedMessagingContentType"> <summary> <para> <para> The supported chat message content types. Supported types are <c>text/plain</c>, <c>text/markdown</c>, <c>application/json</c>, <c>application/vnd.amazonaws.connect.message.interactive</c>, and <c>application/vnd.amazonaws.connect.message.interactive.response</c>. </para><para>Content types must always contain <c> text/plain</c>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <c>text/plain</c>: <c>[text/plain, text/markdown, application/json]</c>, <c> [text/markdown, text/plain]</c>, <c>[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.Event_Type"> <summary> <para> <para>Type of chat integration event. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.Select"> <summary> 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.SendChatIntegrationEventResponse). Specifying the name of a property of type Amazon.Connect.Model.SendChatIntegrationEventResponse 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.CONN.SendCONNChatIntegrationEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DestinationId parameter. The -PassThru parameter is deprecated, use -Select '^DestinationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNChatIntegrationEventCmdlet.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.SendCONNOutboundEmailCmdlet"> <summary> Send outbound email for outbound campaigns. For more information about outbound campaigns, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/enable-outbound-campaigns.html">Set up Amazon Connect outbound campaigns</a>. <note><para> Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.RawMessage_Body"> <summary> <para> <para>The email message body.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.SourceCampaign_CampaignId"> <summary> <para> <para>A unique identifier for a campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.AdditionalRecipients_CcEmailAddress"> <summary> <para> <para>The additional CC email address recipients information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.RawMessage_ContentType"> <summary> <para> <para>Type of content, that is, <c>text/plain</c> or <c>text/html</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.TemplateAttributes_CustomAttribute"> <summary> <para> <para>An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.TemplateAttributes_CustomerProfileAttribute"> <summary> <para> <para>An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.DestinationEmailAddress_DisplayName"> <summary> <para> <para>The display name of email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.FromEmailAddress_DisplayName"> <summary> <para> <para>The display name of email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.DestinationEmailAddress_EmailAddress"> <summary> <para> <para>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.FromEmailAddress_EmailAddress"> <summary> <para> <para>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.TemplatedMessageConfig_KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.EmailMessage_MessageSourceType"> <summary> <para> <para>The message source type, that is, <c>RAW</c> or <c>TEMPLATE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.TemplatedMessageConfig_MessageTemplateId"> <summary> <para> <para>The identifier of the message template Id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.SourceCampaign_OutboundRequestId"> <summary> <para> <para>A unique identifier for a each request part of same campaign.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.RawMessage_Subject"> <summary> <para> <para>The email subject.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.TrafficType"> <summary> <para> <para>Denotes the class of traffic.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.SendOutboundEmailResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SendCONNOutboundEmailCmdlet.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.SetCONNBatchPutContactCmdlet"> <summary> <note><para> Only the Amazon Connect outbound campaigns service principal is allowed to assume a role in your account and call this API. </para></note><para> Allows you to create a batch of contacts in Amazon Connect. The outbound campaigns capability ingests dial requests via the <a href="https://docs.aws.amazon.com/connect-outbound/latest/APIReference/API_PutDialRequestBatch.html">PutDialRequestBatch</a> API. It then uses BatchPutContact to create contacts corresponding to those dial requests. If agents are available, the dial requests are dialed out, which results in a voice call. The resulting voice call uses the same contactId that was created by BatchPutContact. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SetCONNBatchPutContactCmdlet.ContactDataRequestList"> <summary> <para> <para>List of individual contact requests.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SetCONNBatchPutContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SetCONNBatchPutContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SetCONNBatchPutContactCmdlet.Select"> <summary> 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.BatchPutContactResponse). Specifying the name of a property of type Amazon.Connect.Model.BatchPutContactResponse 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.CONN.SetCONNBatchPutContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SetCONNBatchPutContactCmdlet.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.StartCONNAttachedFileUploadCmdlet"> <summary> Provides a pre-signed Amazon S3 URL in response for uploading your content. <important><para> You may only use this API to upload attachments to an <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_connect-cases_CreateCase.html">Amazon Connect Case</a> or <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Amazon Connect Email</a>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.AssociatedResourceArn"> <summary> <para> <para>The resource to which the attached file is (being) uploaded to. The supported resources are <a href="https://docs.aws.amazon.com/connect/latest/adminguide/cases.html">Cases</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-email-channel.html">Email</a>.</para><note><para>This value must be a valid ARN.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.CreatedBy_AWSIdentityArn"> <summary> <para> <para>STS or IAM ARN representing the identity of API Caller. SDK users cannot populate this and this value is calculated automatically if <c>ConnectUserArn</c> is not provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.CreatedBy_ConnectUserArn"> <summary> <para> <para>An agent ARN representing a <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-resources-for-iam-policies">connect user</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.FileName"> <summary> <para> <para>A case-sensitive name of the attached file being uploaded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.FileSizeInByte"> <summary> <para> <para>The size of the attached file in bytes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.FileUseCaseType"> <summary> <para> <para>The use case for the file.</para><important><para> Only <c>ATTACHMENTS</c> are supported.</para></important> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.InstanceId"> <summary> <para> <para>The unique identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.Tag"> <summary> <para> <para>The tags used to organize, track, or control access for this resource. For example, <c>{ "Tags": {"key1":"value1", "key2":"value2"} }</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.UrlExpiryInSecond"> <summary> <para> <para>Optional override for the expiry of the pre-signed S3 URL in seconds. The default value is 300.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.Select"> <summary> 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.StartAttachedFileUploadResponse). Specifying the name of a property of type Amazon.Connect.Model.StartAttachedFileUploadResponse 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.CONN.StartCONNAttachedFileUploadCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNAttachedFileUploadCmdlet.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.StartCONNChatContactCmdlet"> <summary> Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> API in the Amazon Connect Participant Service. <para> When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking <a href="https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html">CreateParticipantConnection</a> with WEBSOCKET and CONNECTION_CREDENTIALS. </para><para> A 429 error occurs in the following situations: </para><ul><li><para> API rate limit is exceeded. API TPS throttling returns a <c>TooManyRequests</c> exception. </para></li><li><para> The <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">quota for concurrent active chats</a> is exceeded. Active chat throttling returns a <c>LimitExceededException</c>. </para></li></ul><para> If you use the <c>ChatDurationInMinutes</c> parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support. </para><para> For more information about chat, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </para><ul><li><para><a href="https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html">Concepts: Web and mobile messaging capabilities in Amazon Connect</a></para></li><li><para><a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in 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.StartCONNChatContactCmdlet.ChatDurationInMinute"> <summary> <para> <para>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </para><para>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.InitialMessage_Content"> <summary> <para> <para>The content of the chat message. </para><ul><li><para>For <c>text/plain</c> and <c>text/markdown</c>, the Length Constraints are Minimum of 1, Maximum of 1024. </para></li><li><para>For <c>application/json</c>, the Length Constraints are Minimum of 1, Maximum of 12000. </para></li><li><para>For <c>application/vnd.amazonaws.connect.message.interactive.response</c>, the Length Constraints are Minimum of 1, Maximum of 12288.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.InitialMessage_ContentType"> <summary> <para> <para>The type of the content. Supported types are <c>text/plain</c>, <c>text/markdown</c>, <c>application/json</c>, and <c>application/vnd.amazonaws.connect.message.interactive.response</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.ParticipantDetails_DisplayName"> <summary> <para> <para>Display name of the participant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.PersistentChat_RehydrationType"> <summary> <para> <para>The contactId that is used for rehydration depends on the rehydration type. RehydrationType is required for persistent chat. </para><ul><li><para><c>ENTIRE_PAST_SESSION</c>: Rehydrates a chat from the most recently terminated past chat contact of the specified past ended chat session. To use this type, provide the <c>initialContactId</c> of the past ended chat session in the <c>sourceContactId</c> field. In this type, Amazon Connect determines the most recent chat contact on the specified chat session that has ended, and uses it to start a persistent chat. </para></li><li><para><c>FROM_SEGMENT</c>: Rehydrates a chat from the past chat contact that is specified in the <c>sourceContactId</c> field. </para></li></ul><para>The actual contactId used for rehydration is provided in the response of this API. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.RelatedContactId"> <summary> <para> <para>The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting.</para><note><para>You cannot provide data for both RelatedContactId and PersistentChat. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.SegmentAttribute"> <summary> <para> <para>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</para><para>Attribute keys can include only alphanumeric, -, and _.</para><para>This field can be used to show channel subtype, such as <c>connect:Guide</c>.</para><note><para>The types <c>application/vnd.amazonaws.connect.message.interactive</c> and <c>application/vnd.amazonaws.connect.message.interactive.response</c> must be present in the SupportedMessagingContentTypes field of this API in order to set <c>SegmentAttributes</c> as {<c> "connect:Subtype": {"valueString" : "connect:Guide" }}</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.PersistentChat_SourceContactId"> <summary> <para> <para>The contactId from which a persistent chat session must be started.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.SupportedMessagingContentType"> <summary> <para> <para>The supported chat message content types. Supported types are <c>text/plain</c>, <c>text/markdown</c>, <c>application/json</c>, <c>application/vnd.amazonaws.connect.message.interactive</c>, and <c>application/vnd.amazonaws.connect.message.interactive.response</c>. </para><para>Content types must always contain <c>text/plain</c>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <c>text/plain</c>: <c>[text/plain, text/markdown, application/json]</c>, <c>[text/markdown, text/plain]</c>, <c>[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]</c>. </para><note><para>The type <c>application/vnd.amazonaws.connect.message.interactive</c> is required to use the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/show-view-block.html">Show view</a> flow block.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.Select"> <summary> 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.StartChatContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartChatContactResponse 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.CONN.StartCONNChatContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNChatContactCmdlet.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.StartCONNContactEvaluationCmdlet"> <summary> Starts an empty evaluation in the specified Amazon Connect instance, using the given evaluation form for the particular contact. The evaluation form version used for the contact evaluation corresponds to the currently activated version. If no version is activated for the evaluation form, the contact evaluation cannot be started. <note><para> Evaluations created through the public API do not contain answer values suggested from automation. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactEvaluationCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactEvaluationCmdlet.EvaluationFormId"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactEvaluationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactEvaluationCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactEvaluationCmdlet.Select"> <summary> 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.StartContactEvaluationResponse). Specifying the name of a property of type Amazon.Connect.Model.StartContactEvaluationResponse 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.CONN.StartCONNContactEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactEvaluationCmdlet.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.StartCONNContactMonitoringCmdlet"> <summary> Initiates silent monitoring of a contact. The Contact Control Panel (CCP) of the user specified by <i>userId</i> will be set to silent monitoring mode on the contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactMonitoringCmdlet.AllowedMonitorCapability"> <summary> <para> <para>Specify which monitoring actions the user is allowed to take. For example, whether the user is allowed to escalate from silent monitoring to barge. AllowedMonitorCapabilities is required if barge is enabled.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactMonitoringCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactMonitoringCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactMonitoringCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactMonitoringCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactMonitoringCmdlet.Select"> <summary> 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.MonitorContactResponse). Specifying the name of a property of type Amazon.Connect.Model.MonitorContactResponse 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.CONN.StartCONNContactMonitoringCmdlet.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.CONN.StartCONNContactMonitoringCmdlet.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.StartCONNContactRecordingCmdlet"> <summary> Starts recording the contact: <ul><li><para> If the API is called <i>before</i> the agent joins the call, recording starts when the agent joins the call. </para></li><li><para> If the API is called <i>after</i> the agent joins the call, recording starts at the time of the API call. </para></li></ul><para> StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording. </para><para> You can use this API to override the recording behavior configured in the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-recording-behavior.html">Set recording behavior</a> block. </para><para> Only voice recordings are supported at this time. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.InitialContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.VoiceRecordingConfiguration_IvrRecordingTrack"> <summary> <para> <para>Identifies which IVR track is being recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.VoiceRecordingConfiguration_VoiceRecordingTrack"> <summary> <para> <para>Identifies which track is being recorded.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartContactRecordingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactRecordingCmdlet.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.StartCONNContactStreamingCmdlet"> <summary> Initiates real-time message streaming for a new chat contact. <para> For more information about message streaming, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html">Enable real-time chat message streaming</a> in the <i>Amazon Connect Administrator Guide</i>. </para><para> For more information about chat, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </para><ul><li><para><a href="https://docs.aws.amazon.com/connect/latest/adminguide/web-and-mobile-chat.html">Concepts: Web and mobile messaging capabilities in Amazon Connect</a></para></li><li><para><a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-best-practices.html#bp-security-chat">Amazon Connect Chat security best practices</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactStreamingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactStreamingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactStreamingCmdlet.ChatStreamingConfiguration_StreamingEndpointArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon Resource Name (ARN) of the streaming endpoint that is used to publish real-time message streaming for chat conversations.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactStreamingCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNContactStreamingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'StreamingId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartContactStreamingResponse). Specifying the name of a property of type Amazon.Connect.Model.StartContactStreamingResponse 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.CONN.StartCONNContactStreamingCmdlet.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.CONN.StartCONNContactStreamingCmdlet.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.StartCONNEmailContactCmdlet"> <summary> Creates an inbound email contact and initiates a flow to start the email contact for the customer. Response of this API provides the ContactId of the email contact created. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.Attachment"> <summary> <para> <para>List of S3 presigned URLs of email attachments and their file name. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.StartCONNEmailContactCmdlet.RawMessage_Body"> <summary> <para> <para>The email message body.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.AdditionalRecipients_CcAddress"> <summary> <para> <para>The additional recipients information present in cc list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow for initiating the emails. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </para><para>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.RawMessage_ContentType"> <summary> <para> <para>Type of content, that is, <c>text/plain</c> or <c>text/html</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.Description"> <summary> <para> <para>A description of the email contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.DestinationEmailAddress"> <summary> <para> <para>The email address associated with the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.FromEmailAddress_DisplayName"> <summary> <para> <para>The display name of email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.FromEmailAddress_EmailAddress"> <summary> <para> <para>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.RawMessage_Header"> <summary> <para> <para>Headers present in inbound email.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.EmailMessage_MessageSourceType"> <summary> <para> <para>The message source type, that is, <c>RAW</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.Name"> <summary> <para> <para>The name of a email that is shown to an agent in the Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.Reference"> <summary> <para> <para>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Emails can have the following reference types at the time of creation: <c>URL</c> | <c>NUMBER</c> | <c>STRING</c> | <c>DATE</c>. <c>EMAIL</c> | <c>EMAIL_MESSAGE</c> |<c>ATTACHMENT</c> are not a supported reference type during email creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.RelatedContactId"> <summary> <para> <para>The contactId that is related to this contact. Linking emails together by using <c>RelatedContactID</c> copies over contact attributes from the related email contact to the new email contact. All updates to user-defined attributes in the new email contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using <c>RelatedContactId</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.SegmentAttribute"> <summary> <para> <para>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</para><para>Attribute keys can include only alphanumeric, -, and _.</para><para>This field can be used to show channel subtype, such as <c>connect:Guide</c>.</para><note><para>To set contact expiry, a <c>ValueMap</c> must be specified containing the integer number of minutes the contact will be active for before expiring, with <c>SegmentAttributes</c> like { <c> "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger":135}}}}</c>.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.RawMessage_Subject"> <summary> <para> <para>The email subject.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.AdditionalRecipients_ToAddress"> <summary> <para> <para>The additional recipients information present in to list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartEmailContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartEmailContactResponse 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.CONN.StartCONNEmailContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNEmailContactCmdlet.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.StartCONNOutboundChatContactCmdlet"> <summary> Initiates a new outbound SMS contact to a customer. Response of this API provides the <c>ContactId</c> of the outbound SMS contact created. <para><b>SourceEndpoint</b> only supports Endpoints with <c>CONNECT_PHONENUMBER_ARN</c> as Type and <b>DestinationEndpoint</b> only supports Endpoints with <c>TELEPHONE_NUMBER</c> as Type. <b>ContactFlowId</b> initiates the flow to manage the new SMS contact created. </para><para> This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartOutboundChatContact.html">StartOutboundChatContact</a> Flow Action. </para><para> For more information about using SMS in Amazon Connect, see the following topics in the <i>Amazon Connect Administrator Guide</i>: </para><ul><li><para><a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-sms-messaging.html">Set up SMS messaging</a></para></li><li><para><a href="https://docs.aws.amazon.com/connect/latest/adminguide/sms-number.html">Request an SMS-enabled phone number through AWS End User Messaging SMS</a></para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.DestinationEndpoint_Address"> <summary> <para> <para>Address of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.SourceEndpoint_Address"> <summary> <para> <para>Address of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.ChatDurationInMinute"> <summary> <para> <para>The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to <b>Routing, Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold:</para><ul><li><para>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>123ec456-a007-89c0-1234-xxxxxxxxxxxx</b></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.InitialSystemMessage_Content"> <summary> <para> <para>The content of the chat message. </para><ul><li><para>For <c>text/plain</c> and <c>text/markdown</c>, the Length Constraints are Minimum of 1, Maximum of 1024. </para></li><li><para>For <c>application/json</c>, the Length Constraints are Minimum of 1, Maximum of 12000. </para></li><li><para>For <c>application/vnd.amazonaws.connect.message.interactive.response</c>, the Length Constraints are Minimum of 1, Maximum of 12288.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.InitialSystemMessage_ContentType"> <summary> <para> <para>The type of the content. Supported types are <c>text/plain</c>, <c>text/markdown</c>, <c>application/json</c>, and <c>application/vnd.amazonaws.connect.message.interactive.response</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.ParticipantDetails_DisplayName"> <summary> <para> <para>Display name of the participant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.RelatedContactId"> <summary> <para> <para>The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.SegmentAttribute"> <summary> <para> <para>A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</para><ul><li><para>Attribute keys can include only alphanumeric, <c>-</c>, and <c>_</c>.</para></li><li><para>This field can be used to show channel subtype, such as <c>connect:Guide</c> and <c>connect:SMS</c>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.SupportedMessagingContentType"> <summary> <para> <para>The supported chat message content types. Supported types are:</para><ul><li><para><c>text/plain</c></para></li><li><para><c>text/markdown</c></para></li><li><para><c>application/json, application/vnd.amazonaws.connect.message.interactive</c></para></li><li><para><c>application/vnd.amazonaws.connect.message.interactive.response</c></para></li></ul><para>Content types must always contain <c>text/plain</c>. You can then put any other supported type in the list. For example, all the following lists are valid because they contain <c>text/plain</c>:</para><ul><li><para><c>[text/plain, text/markdown, application/json]</c></para></li><li><para><c>[text/markdown, text/plain]</c></para></li><li><para><c>[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]</c></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.DestinationEndpoint_Type"> <summary> <para> <para>Type of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.SourceEndpoint_Type"> <summary> <para> <para>Type of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundChatContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartOutboundChatContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartOutboundChatContactResponse 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.CONN.StartCONNOutboundChatContactCmdlet.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.StartCONNOutboundEmailContactCmdlet"> <summary> Initiates a flow to send an agent reply or outbound email contact (created from the CreateContact API) to a customer. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.RawMessage_Body"> <summary> <para> <para>The email message body.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.AdditionalRecipients_CcEmailAddress"> <summary> <para> <para>The additional CC email address recipients information.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.RawMessage_ContentType"> <summary> <para> <para>Type of content, that is, <c>text/plain</c> or <c>text/html</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.TemplateAttributes_CustomAttribute"> <summary> <para> <para>An object that specifies the custom attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.TemplateAttributes_CustomerProfileAttribute"> <summary> <para> <para>An object that specifies the customer profile attributes values to use for variables in the message template. This object contains different categories of key-value pairs. Each key defines a variable or placeholder in the message template. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.DestinationEmailAddress_DisplayName"> <summary> <para> <para>The display name of email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.FromEmailAddress_DisplayName"> <summary> <para> <para>The display name of email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.DestinationEmailAddress_EmailAddress"> <summary> <para> <para>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.FromEmailAddress_EmailAddress"> <summary> <para> <para>The email address with the instance, in [^\s@]+@[^\s@]+\.[^\s@]+ format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.TemplatedMessageConfig_KnowledgeBaseId"> <summary> <para> <para>The identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.EmailMessage_MessageSourceType"> <summary> <para> <para>The message source type, that is, <c>RAW</c> or <c>TEMPLATE</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.TemplatedMessageConfig_MessageTemplateId"> <summary> <para> <para>The identifier of the message template Id.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.RawMessage_Subject"> <summary> <para> <para>The email subject.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartOutboundEmailContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartOutboundEmailContactResponse 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.CONN.StartCONNOutboundEmailContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundEmailContactCmdlet.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> Places an outbound call to a contact, and then initiates the flow. It performs the actions in the flow that's specified (in <c>ContactFlowId</c>). <para> Agents do not initiate the outbound API, which means that they do not dial the contact. If the flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case. </para><para> There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails. </para><note><para> UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect Service Quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </para></note><note><para> Campaign calls are not allowed by default. Before you can make a call with <c>TrafficType</c> = <c>CAMPAIGN</c>, you must submit a service quota increase request to the quota <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#outbound-communications-quotas">Amazon Connect campaigns</a>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.StartCONNOutboundVoiceContactCmdlet.AnswerMachineDetectionConfig_AwaitAnswerMachinePrompt"> <summary> <para> <para>Wait for the answering machine prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.CampaignId"> <summary> <para> <para>The campaign identifier of the outbound communication.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Contact Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </para><para>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Description"> <summary> <para> <para>A description of the voice contact that is shown to an agent in the Contact Control Panel (CCP).</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.AnswerMachineDetectionConfig_EnableAnswerMachineDetection"> <summary> <para> <para>The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to <c>true</c>, <c>TrafficType</c> must be set as <c>CAMPAIGN</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Name"> <summary> <para> <para>The name of a voice contact that is shown to an agent in the Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.QueueId"> <summary> <para> <para>The queue for the call. 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 defined in the flow is used. If you do not specify a queue, you must specify a source phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Reference"> <summary> <para> <para>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Contacts can have the following reference types at the time of creation: <c>URL</c> | <c>NUMBER</c> | <c>STRING</c> | <c>DATE</c> | <c>EMAIL</c>. <c>ATTACHMENT</c> is not a supported reference type during voice contact creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.RelatedContactId"> <summary> <para> <para>The <c>contactId</c> that is related to this contact. Linking voice, task, or chat by using <c>RelatedContactID</c> copies over contact attributes from the related contact to the new contact. All updates to user-defined attributes in the new contact are limited to the individual contact ID. There are no limits to the number of contacts that can be linked by using <c>RelatedContactId</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.SourcePhoneNumber"> <summary> <para> <para>The phone number associated with the Amazon Connect instance, in E.164 format. If you do not specify a source phone number, you must specify a queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.TrafficType"> <summary> <para> <para>Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is <c>GENERAL</c>. Use <c>CAMPAIGN</c> if <c>EnableAnswerMachineDetection</c> is set to <c>true</c>. For all other cases, use <c>GENERAL</c>. </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. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNOutboundVoiceContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartOutboundVoiceContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartOutboundVoiceContactResponse 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.CONN.StartCONNOutboundVoiceContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </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.StartCONNScreenSharingCmdlet"> <summary> Starts screen sharing for a contact. For more information about screen sharing, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/inapp-calling.html">Set up in-app, web, video calling, and screen sharing capabilities</a> in the <i>Amazon Connect Administrator Guide</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNScreenSharingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNScreenSharingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNScreenSharingCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNScreenSharingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartScreenSharingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNScreenSharingCmdlet.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.CONN.StartCONNScreenSharingCmdlet.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.StartCONNTaskContactCmdlet"> <summary> Initiates a flow to start a new task contact. For more information about task contacts, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html">Concepts: Tasks in Amazon Connect</a> in the <i>Amazon Connect Administrator Guide</i>. <para> When using <c>PreviousContactId</c> and <c>RelatedContactId</c> input parameters, note the following: </para><ul><li><para><c>PreviousContactId</c></para><ul><li><para> Any updates to user-defined task contact attributes on any contact linked through the same <c>PreviousContactId</c> will affect every contact in the chain. </para></li><li><para> There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts can be created that share the same <c>PreviousContactId</c>. </para></li></ul></li><li><para><c>RelatedContactId</c></para><ul><li><para> Copies contact attributes from the related task contact to the new contact. </para></li><li><para> Any update on attributes in a new task contact does not update attributes on previous contact. </para></li><li><para> There’s no limit on the number of task contacts that can be created that use the same <c>RelatedContactId</c>. </para></li></ul></li></ul><para> In addition, when calling StartTaskContact include only one of these parameters: <c>ContactFlowID</c>, <c>QuickConnectID</c>, or <c>TaskTemplateID</c>. Only one parameter is required as long as the task template has a flow configured to run it. If more than one parameter is specified, or only the <c>TaskTemplateID</c> is specified but it does not have a flow configured, the request returns an error because Amazon Connect cannot identify the unique flow to run when the task is created. </para><para> A <c>ServiceQuotaExceededException</c> occurs when the number of open tasks exceeds the active tasks quota or there are already 12 tasks referencing the same <c>PreviousContactId</c>. For more information about service quotas for task contacts, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html">Amazon Connect service quotas</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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.StartCONNTaskContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </para><para>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.Description"> <summary> <para> <para>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.Name"> <summary> <para> <para>The name of a task that is shown to an agent in the Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.PreviousContactId"> <summary> <para> <para>The identifier of the previous chat, voice, or task contact. Any updates to user-defined attributes to task contacts linked using the same <c>PreviousContactID</c> will affect every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.QuickConnectId"> <summary> <para> <para>The identifier for the quick connect. Tasks that are created by using <c>QuickConnectId</c> will use the flow that is defined on agent or queue quick connect. For more information about quick connects, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/quick-connects.html">Create quick connects</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.Reference"> <summary> <para> <para>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: <c>URL</c> | <c>NUMBER</c> | <c>STRING</c> | <c>DATE</c> | <c>EMAIL</c>. <c>ATTACHMENT</c> is not a supported reference type during task creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.RelatedContactId"> <summary> <para> <para>The contactId that is <a href="https://docs.aws.amazon.com/connect/latest/adminguide/tasks.html#linked-tasks">related</a> to this contact. Linking tasks together by using <c>RelatedContactID</c> copies over contact attributes from the related task contact to the new task contact. All updates to user-defined attributes in the new task contact are limited to the individual contact ID, unlike what happens when tasks are linked by using <c>PreviousContactID</c>. There are no limits to the number of contacts that can be linked by using <c>RelatedContactId</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.ScheduledTime"> <summary> <para> <para>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.SegmentAttribute"> <summary> <para> <para>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</para><para>Attribute keys can include only alphanumeric, -, and _.</para><para>This field can be used to set Contact Expiry as a duration in minutes and set a UserId for the User who created a task.</para><note><para>To set contact expiry, a ValueMap must be specified containing the integer number of minutes the contact will be active for before expiring, with <c>SegmentAttributes</c> like { <c> "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}}</c>. </para><para>To set the created by user, a valid AgentResourceId must be supplied, with <c>SegmentAttributes</c> like { <c>"connect:CreatedByUser" { "ValueString": "arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/agent/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}}}</c>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.TaskTemplateId"> <summary> <para> <para>A unique identifier for the task template. For more information about task templates, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/task-templates.html">Create task templates</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ContactId'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StartTaskContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartTaskContactResponse 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.CONN.StartCONNTaskContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNTaskContactCmdlet.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.StartCONNWebRTCContactCmdlet"> <summary> Places an inbound in-app, web, or video call to a contact, and then initiates the flow. It performs the actions in the flow that are specified (in ContactFlowId) and present in the Amazon Connect instance (specified as InstanceId). </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Attribute"> <summary> <para> <para>A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in 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, -, and _ characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to <b>Routing</b>, <b>Flows</b>. Choose the flow. On the flow page, under the name of the flow, choose <b>Show additional flow information</b>. The ContactFlowId is the last part of the ARN, shown here in bold: </para><para>arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/<b>846ec553-a005-41c0-8341-xxxxxxxxxxxx</b></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Description"> <summary> <para> <para>A description of the task that is shown to an agent in the Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.ParticipantDetails_DisplayName"> <summary> <para> <para>Display name of the participant.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Reference"> <summary> <para> <para>A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have the following reference types at the time of creation: <c>URL</c> | <c>NUMBER</c> | <c>STRING</c> | <c>DATE</c> | <c>EMAIL</c>. <c>ATTACHMENT</c> is not a supported reference type during task creation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.RelatedContactId"> <summary> <para> <para>The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Agent_ScreenShare"> <summary> <para> <para>The screen sharing capability that is enabled for the participant. <c>SEND</c> indicates the participant can share their screen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Customer_ScreenShare"> <summary> <para> <para>The screen sharing capability that is enabled for the participant. <c>SEND</c> indicates the participant can share their screen.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Agent_Video"> <summary> <para> <para>The configuration having the video and screen sharing capabilities for participants over the call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Customer_Video"> <summary> <para> <para>The configuration having the video and screen sharing capabilities for participants over the call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para><para>The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.Select"> <summary> 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.StartWebRTCContactResponse). Specifying the name of a property of type Amazon.Connect.Model.StartWebRTCContactResponse 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.CONN.StartCONNWebRTCContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StartCONNWebRTCContactCmdlet.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 specified contact. Use this API to stop queued callbacks. It does not work for voice contacts that use the following initiation methods: <ul><li><para> DISCONNECT </para></li><li><para> TRANSFER </para></li><li><para> QUEUE_TRANSFER </para></li><li><para> EXTERNAL_OUTBOUND </para></li><li><para> MONITOR </para></li></ul><para> Chat and task contacts can be terminated in any state, regardless of initiation method. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.DisconnectReason_Code"> <summary> <para> <para>A code that indicates how the contact was terminated.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.ContactId"> <summary> <para> <para>The ID of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StopContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactCmdlet.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.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.StopCONNContactRecordingCmdlet"> <summary> Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording. <para> Only voice recordings are supported at this time. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.ContactRecordingType"> <summary> <para> <para>The type of recording being operated on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.InitialContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StopContactRecordingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactRecordingCmdlet.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.StopCONNContactStreamingCmdlet"> <summary> Ends message streaming on a specified contact. To restart message streaming on that contact, call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html">StartContactStreaming</a> API. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactStreamingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact that is associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactStreamingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactStreamingCmdlet.StreamingId"> <summary> <para> <para>The identifier of the streaming configuration enabled. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactStreamingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.StopContactStreamingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.StopCONNContactStreamingCmdlet.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.CONN.StopCONNContactStreamingCmdlet.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.SubmitCONNContactEvaluationCmdlet"> <summary> Submits a contact evaluation in the specified Amazon Connect instance. Answers included in the request are merged with existing answers for the given evaluation. If no answers or notes are passed, the evaluation is submitted with the existing answers and notes. You can delete an answer or note by passing an empty object (<c>{}</c>) to the question identifier. <para> If a contact evaluation is already in submitted state, this operation will trigger a resubmission. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SubmitCONNContactEvaluationCmdlet.Answer"> <summary> <para> <para>A map of question identifiers to answer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SubmitCONNContactEvaluationCmdlet.EvaluationId"> <summary> <para> <para>A unique identifier for the contact evaluation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SubmitCONNContactEvaluationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SubmitCONNContactEvaluationCmdlet.Note"> <summary> <para> <para>A map of question identifiers to note value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SubmitCONNContactEvaluationCmdlet.Select"> <summary> 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.SubmitContactEvaluationResponse). Specifying the name of a property of type Amazon.Connect.Model.SubmitContactEvaluationResponse 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.CONN.SubmitCONNContactEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SubmitCONNContactEvaluationCmdlet.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.SuspendCONNContactRecordingCmdlet"> <summary> When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen. <para> The period of time that the recording is suspended is filled with silence in the final recording. </para><para> Voice and screen recordings are supported. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.ContactRecordingType"> <summary> <para> <para>The type of recording being operated on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.InitialContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.SuspendContactRecordingResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.SuspendCONNContactRecordingCmdlet.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.UnregisterCONNAnalyticsDataSetCmdlet"> <summary> Removes the dataset ID associated with a given Amazon Connect instance. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNAnalyticsDataSetCmdlet.DataSetId"> <summary> <para> <para>The identifier of the dataset to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNAnalyticsDataSetCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNAnalyticsDataSetCmdlet.TargetAccountId"> <summary> <para> <para>The identifier of the target account. Use to associate a dataset to a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNAnalyticsDataSetCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DisassociateAnalyticsDataSetResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNAnalyticsDataSetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNAnalyticsDataSetCmdlet.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.UnregisterCONNBatchAnalyticsDataSetCmdlet"> <summary> Removes a list of analytics datasets associated with a given Amazon Connect instance. You can disassociate multiple datasets in a single call. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNBatchAnalyticsDataSetCmdlet.DataSetId"> <summary> <para> <para>An array of associated dataset identifiers to remove.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNBatchAnalyticsDataSetCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNBatchAnalyticsDataSetCmdlet.TargetAccountId"> <summary> <para> <para>The identifier of the target account. Use to disassociate a dataset from a different account than the one containing the Amazon Connect instance. If not specified, by default this value is the Amazon Web Services account that has the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNBatchAnalyticsDataSetCmdlet.Select"> <summary> 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.BatchDisassociateAnalyticsDataSetResponse). Specifying the name of a property of type Amazon.Connect.Model.BatchDisassociateAnalyticsDataSetResponse 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.CONN.UnregisterCONNBatchAnalyticsDataSetCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UnregisterCONNBatchAnalyticsDataSetCmdlet.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.UpdateCONNAgentStatusCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates agent status. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.AgentStatusId"> <summary> <para> <para>The identifier of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.Description"> <summary> <para> <para>The description of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.DisplayOrder"> <summary> <para> <para>The display order of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.Name"> <summary> <para> <para>The name of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.ResetOrderNumber"> <summary> <para> <para>A number indicating the reset order of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.State"> <summary> <para> <para>The state of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateAgentStatusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAgentStatusCmdlet.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.UpdateCONNAuthenticationProfileCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. To request access to this API, contact Amazon Web Services Support. <para> Updates the selected authentication profile. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.AllowedIp"> <summary> <para> <para>A list of IP address range strings that are allowed to access the instance. For more information on how to configure IP addresses, see<a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.AuthenticationProfileId"> <summary> <para> <para>A unique identifier for the authentication profile. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.BlockedIp"> <summary> <para> <para>A list of IP address range strings that are blocked from accessing the instance. For more information on how to configure IP addresses, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-ip-based-ac">Configure IP-based access control</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.Description"> <summary> <para> <para>The description for the authentication profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.Name"> <summary> <para> <para>The name for the authentication profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.PeriodicSessionDuration"> <summary> <para> <para>The short lived session duration configuration for users logged in to Amazon Connect, in minutes. This value determines the maximum possible time before an agent is authenticated. For more information, For more information on how to configure IP addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/authentication-profiles.html#configure-session-timeouts">Configure session timeouts</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateAuthenticationProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the AuthenticationProfileId parameter. The -PassThru parameter is deprecated, use -Select '^AuthenticationProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNAuthenticationProfileCmdlet.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.UpdateCONNContactCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request. </para><important><para> You can add or update user-defined contact information for both ongoing and completed contacts. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.CustomerEndpoint_Address"> <summary> <para> <para>Address of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.SystemEndpoint_Address"> <summary> <para> <para>Address of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.Description"> <summary> <para> <para>The description of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.QueueInfo_Id"> <summary> <para> <para>The identifier of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.Name"> <summary> <para> <para>The name of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.Reference"> <summary> <para> <para>Well-formed data on contact, shown to agents on Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.SegmentAttribute"> <summary> <para> <para>A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.</para><para>Attribute keys can include only alphanumeric, -, and _.</para><para>This field can be used to show channel subtype, such as <c>connect:Guide</c>.</para><para>Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.CustomerEndpoint_Type"> <summary> <para> <para>Type of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.SystemEndpoint_Type"> <summary> <para> <para>Type of the endpoint.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.UserInfo_UserId"> <summary> <para> <para>The user identifier for the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactCmdlet.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.CONN.UpdateCONNContactCmdlet.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> Creates or updates user-defined contact attributes associated with the specified contact. <para> You can create or update user-defined attributes for both ongoing and completed contacts. For example, while the call is active, you can update the customer's name or the reason the customer called. You can add notes about steps that the agent took during the call that display to the next agent that takes the call. You can also 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 to identify abusive callers. </para><para> Contact attributes are available in Amazon Connect for 24 months, and are then deleted. For information about contact record retention and the maximum size of the contact record attributes section, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits">Feature specifications</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.Attribute"> <summary> <para> <para>The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact attributes.</para><para>You can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys can include only alphanumeric, dash, and underscore characters.</para><para>When the attributes for a contact exceed 32 KB, the contact is routed down the Error branch of the flow. As a mitigation, consider the following options:</para><ul><li><para>Remove unnecessary attributes by setting their values to empty.</para></li><li><para>If the attributes are only used in one flow and don't need to be referred to outside of that flow (for example, by a Lambda or another flow), then use flow attributes. This way you aren't needlessly persisting the 32 KB of information from one flow to another. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-contact-attributes.html">Flow block: Set contact attributes</a> in the <i>Amazon Connect Administrator Guide</i>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.InitialContactId"> <summary> <para> <para>The identifier of the contact. This is the identifier of 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 of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactAttributesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the InitialContactId parameter. The -PassThru parameter is deprecated, use -Select '^InitialContactId' instead. This parameter will be removed in a future version. </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.UpdateCONNContactEvaluationCmdlet"> <summary> Updates details about a contact evaluation in the specified Amazon Connect instance. A contact evaluation must be in draft state. Answers included in the request are merged with existing answers for the given evaluation. An answer or note can be deleted by passing an empty object (<c>{}</c>) to the question identifier. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactEvaluationCmdlet.Answer"> <summary> <para> <para>A map of question identifiers to answer value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactEvaluationCmdlet.EvaluationId"> <summary> <para> <para>A unique identifier for the contact evaluation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactEvaluationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactEvaluationCmdlet.Note"> <summary> <para> <para>A map of question identifiers to note value.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactEvaluationCmdlet.Select"> <summary> 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.UpdateContactEvaluationResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdateContactEvaluationResponse 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.CONN.UpdateCONNContactEvaluationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactEvaluationCmdlet.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.UpdateCONNContactFlowContentCmdlet"> <summary> Updates the specified flow. <para> You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect Flow language</a>. </para><para> Use the <c>$SAVED</c> alias in the request to describe the <c>SAVED</c> content of a Flow. For example, <c>arn:aws:.../contact-flow/{id}:$SAVED</c>. After a flow is published, <c>$SAVED</c> needs to be supplied to view saved content that has not been published. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowContentCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowContentCmdlet.Content"> <summary> <para> <para>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example flow in Amazon Connect Flow language</a>. </para><para>Length Constraints: Minimum length of 1. Maximum length of 256000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowContentCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactFlowContentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowContentCmdlet.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.UpdateCONNContactFlowMetadataCmdlet"> <summary> Updates metadata about specified flow. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.ContactFlowState"> <summary> <para> <para>The state of flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.Description"> <summary> <para> <para>The description of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.Name"> <summary> <para> <para>The name of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactFlowMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowMetadataCmdlet.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.UpdateCONNContactFlowModuleContentCmdlet"> <summary> Updates specified flow module for the specified Amazon Connect instance. <para> Use the <c>$SAVED</c> alias in the request to describe the <c>SAVED</c> content of a Flow. For example, <c>arn:aws:.../contact-flow/{id}:$SAVED</c>. After a flow is published, <c>$SAVED</c> needs to be supplied to view saved content that has not been published. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleContentCmdlet.ContactFlowModuleId"> <summary> <para> <para>The identifier of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleContentCmdlet.Content"> <summary> <para> <para>The JSON string that represents the content of the flow. For an example, see <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html">Example flow in Amazon Connect Flow language</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleContentCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactFlowModuleContentResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleContentCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowModuleId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowModuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleContentCmdlet.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.UpdateCONNContactFlowModuleMetadataCmdlet"> <summary> Updates metadata about specified flow module. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.ContactFlowModuleId"> <summary> <para> <para>The identifier of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.Description"> <summary> <para> <para>The description of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.Name"> <summary> <para> <para>The name of the flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.State"> <summary> <para> <para>The state of flow module.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactFlowModuleMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowModuleId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowModuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowModuleMetadataCmdlet.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.UpdateCONNContactFlowNameCmdlet"> <summary> The name of the flow. <para> You can also create and update flows using the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html">Amazon Connect Flow language</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.Description"> <summary> <para> <para>The description of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.Name"> <summary> <para> <para>The name of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactFlowNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ContactFlowId parameter. The -PassThru parameter is deprecated, use -Select '^ContactFlowId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactFlowNameCmdlet.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.UpdateCONNContactRoutingDataCmdlet"> <summary> Updates routing priority and age on the contact (<b>QueuePriority</b> and <b>QueueTimeAdjustmentInSeconds</b>). These properties can be used to change a customer's position in the queue. For example, you can move a contact to the back of the queue by setting a lower routing priority relative to other contacts in queue; or you can move a contact to the front of the queue by increasing the routing age which will make the contact look artificially older and therefore higher up in the first-in-first-out routing order. Note that adjusting the routing age of a contact affects only its position in queue, and not its actual queue wait time as reported through metrics. These properties can also be updated by using <a href="https://docs.aws.amazon.com/connect/latest/adminguide/change-routing-priority.html">the Set routing priority / age flow block</a>. <note><para> Either <b>QueuePriority</b> or <b>QueueTimeAdjustmentInSeconds</b> should be provided within the request body, but not both. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.QueuePriority"> <summary> <para> <para>Priority of the contact in the queue. The default priority for new contacts is 5. You can raise the priority of a contact compared to other contacts in the queue by assigning them a higher priority, such as 1 or 2.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.QueueTimeAdjustmentSecond"> <summary> <para> <para>The number of seconds to add or subtract from the contact's routing age. Contacts are routed to agents on a first-come, first-serve basis. This means that changing their amount of time in queue compared to others also changes their position in queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.RoutingCriteria_Step"> <summary> <para> <para>When Amazon Connect does not find an available agent meeting the requirements in a step for a given step duration, the routing criteria will move on to the next step sequentially until a join is completed with an agent. When all steps are exhausted, the contact will be offered to any agent in the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactRoutingDataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactRoutingDataCmdlet.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.CONN.UpdateCONNContactRoutingDataCmdlet.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.UpdateCONNContactScheduleCmdlet"> <summary> Updates the scheduled time of a task contact that is already scheduled. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactScheduleCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactScheduleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactScheduleCmdlet.ScheduledTime"> <summary> <para> <para>The timestamp, in Unix Epoch seconds format, at which to start running the inbound flow. The scheduled time cannot be in the past. It must be within up to 6 days in future. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactScheduleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateContactScheduleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNContactScheduleCmdlet.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.CONN.UpdateCONNContactScheduleCmdlet.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.UpdateCONNEmailAddressMetadataCmdlet"> <summary> Updates an email address metadata. For more information about email addresses, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/create-email-address1.html">Create email addresses</a> in the Amazon Connect Administrator Guide. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.Description"> <summary> <para> <para>The description of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.DisplayName"> <summary> <para> <para>The display name of email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.EmailAddressId"> <summary> <para> <para>The identifier of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.Select"> <summary> 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.UpdateEmailAddressMetadataResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdateEmailAddressMetadataResponse 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.CONN.UpdateCONNEmailAddressMetadataCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEmailAddressMetadataCmdlet.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.UpdateCONNEvaluationFormCmdlet"> <summary> Updates details about a specific evaluation form version in the specified Amazon Connect instance. Question and section identifiers cannot be duplicated within the same evaluation form. <para> This operation does not support partial updates. Instead it does a full update of evaluation form content. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.CreateNewVersion"> <summary> <para> <para>A flag indicating whether the operation must create a new version.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.Description"> <summary> <para> <para>The description of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.EvaluationFormId"> <summary> <para> <para>The unique identifier for the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.EvaluationFormVersion"> <summary> <para> <para>A version of the evaluation form to update.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.Item"> <summary> <para> <para>Items that are part of the evaluation form. The total number of sections and questions must not exceed 100 each. Questions must be contained in a section.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.ScoringStrategy_Mode"> <summary> <para> <para>The scoring mode of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.ScoringStrategy_Status"> <summary> <para> <para>The scoring status of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.Title"> <summary> <para> <para>A title of the evaluation form.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.Select"> <summary> 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.UpdateEvaluationFormResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdateEvaluationFormResponse 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.CONN.UpdateCONNEvaluationFormCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the EvaluationFormId parameter. The -PassThru parameter is deprecated, use -Select '^EvaluationFormId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNEvaluationFormCmdlet.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.UpdateCONNHoursOfOperationCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the hours of operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.Config"> <summary> <para> <para>Configuration information of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.Description"> <summary> <para> <para>The description of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.HoursOfOperationId"> <summary> <para> <para>The identifier of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.Name"> <summary> <para> <para>The name of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.TimeZone"> <summary> <para> <para>The time zone of the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateHoursOfOperationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNHoursOfOperationCmdlet.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.UpdateCONNInstanceAttributeCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the value for the specified attribute type. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceAttributeCmdlet.AttributeType"> <summary> <para> <para>The type of attribute.</para><note><para>Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact Amazon Web Services Support for allowlisting.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceAttributeCmdlet.Value"> <summary> <para> <para>The value for the attribute. Maximum character limit is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateInstanceAttributeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceAttributeCmdlet.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.UpdateCONNInstanceStorageConfigCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates an existing configuration for a resource type. This API is idempotent. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.AssociationId"> <summary> <para> <para>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.StorageConfig_AssociationId"> <summary> <para> <para>The existing association identifier that uniquely identifies the resource type and storage config for the given instance ID.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.S3Config_BucketName"> <summary> <para> <para>The S3 bucket name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.S3Config_BucketPrefix"> <summary> <para> <para>The S3 bucket prefix.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.StorageConfigKinesisVideoStreamConfigEncryptionConfigEncryptionType"> <summary> <para> <para>The type of encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.StorageConfigS3ConfigEncryptionConfigEncryptionType"> <summary> <para> <para>The type of encryption.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.KinesisFirehoseConfig_FirehoseArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the delivery stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.StorageConfigKinesisVideoStreamConfigEncryptionConfigKeyId"> <summary> <para> <para>The full ARN of the encryption key. </para><note><para>Be sure to provide the full ARN of the encryption key, not just the ID.</para><para>Amazon Connect supports only KMS keys with the default key spec of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default"><c>SYMMETRIC_DEFAULT</c></a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.StorageConfigS3ConfigEncryptionConfigKeyId"> <summary> <para> <para>The full ARN of the encryption key. </para><note><para>Be sure to provide the full ARN of the encryption key, not just the ID.</para><para>Amazon Connect supports only KMS keys with the default key spec of <a href="https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default"><c>SYMMETRIC_DEFAULT</c></a>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.KinesisVideoStreamConfig_Prefix"> <summary> <para> <para>The prefix of the video stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.ResourceType"> <summary> <para> <para>A valid resource type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.KinesisVideoStreamConfig_RetentionPeriodHour"> <summary> <para> <para>The number of hours data is retained in the stream. Kinesis Video Streams retains the data in a data store that is associated with the stream.</para><para>The default value is 0, indicating that the stream does not persist data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.StorageConfig_StorageType"> <summary> <para> <para>A valid storage type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.KinesisStreamConfig_StreamArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the data stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateInstanceStorageConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNInstanceStorageConfigCmdlet.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.UpdateCONNParticipantRoleConfigCmdlet"> <summary> Updates timeouts for when human chat participants are to be considered idle, and when agents are automatically disconnected from a chat due to idleness. You can set four timers: <ul><li><para> Customer idle timeout </para></li><li><para> Customer auto-disconnect timeout </para></li><li><para> Agent idle timeout </para></li><li><para> Agent auto-disconnect timeout </para></li></ul><para> For more information about how chat timeouts work, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html">Set up chat timeouts for human participants</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNParticipantRoleConfigCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact in this instance of Amazon Connect. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNParticipantRoleConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNParticipantRoleConfigCmdlet.Chat_ParticipantTimerConfigList"> <summary> <para> <para>A list of participant timers. You can specify any unique combination of role and timer type. Duplicate entries error out the request with a 400.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNParticipantRoleConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateParticipantRoleConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNParticipantRoleConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNParticipantRoleConfigCmdlet.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.UpdateCONNPhoneNumberCmdlet"> <summary> Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region. <important><para> After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too. </para><para> You can call <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API to verify the status of a previous <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html">UpdatePhoneNumber</a> operation. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance that phone numbers are claimed to. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance. You must enter <c>InstanceId</c> or <c>TargetArn</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberCmdlet.PhoneNumberId"> <summary> <para> <para>A unique identifier for the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberCmdlet.TargetArn"> <summary> <para> <para>The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter <c>InstanceId</c> or <c>TargetArn</c>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberCmdlet.Select"> <summary> 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.UpdatePhoneNumberResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdatePhoneNumberResponse 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.CONN.UpdateCONNPhoneNumberCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberCmdlet.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.UpdateCONNPhoneNumberMetadataCmdlet"> <summary> Updates a phone number’s metadata. <important><para> To verify the status of a previous UpdatePhoneNumberMetadata operation, call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html">DescribePhoneNumber</a> API. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberMetadataCmdlet.PhoneNumberDescription"> <summary> <para> <para>The description of the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberMetadataCmdlet.PhoneNumberId"> <summary> <para> <para>The Amazon Resource Name (ARN) or resource ID of the phone number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberMetadataCmdlet.ClientToken"> <summary> <para> <para>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdatePhoneNumberMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberMetadataCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the PhoneNumberId parameter. The -PassThru parameter is deprecated, use -Select '^PhoneNumberId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPhoneNumberMetadataCmdlet.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.UpdateCONNPredefinedAttributeCmdlet"> <summary> Updates a predefined attribute for the specified Amazon Connect instance. <i>Predefined attributes</i> are attributes in an Amazon Connect instance that can be used to route contacts to an agent or pools of agents within a queue. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/predefined-attributes.html">Create predefined attributes for routing contacts to agents</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPredefinedAttributeCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPredefinedAttributeCmdlet.Name"> <summary> <para> <para>The name of the predefined attribute.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPredefinedAttributeCmdlet.Values_StringList"> <summary> <para> <para>Predefined attribute values of type string list.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPredefinedAttributeCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdatePredefinedAttributeResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPredefinedAttributeCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPredefinedAttributeCmdlet.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.UpdateCONNPromptCmdlet"> <summary> Updates a prompt. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.Description"> <summary> <para> <para>A description of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.Name"> <summary> <para> <para>The name of the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.PromptId"> <summary> <para> <para>A unique identifier for the prompt.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.S3Uri"> <summary> <para> <para>The URI for the S3 bucket where the prompt is stored. You can provide S3 pre-signed URLs returned by the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetPromptFile.html">GetPromptFile</a> API instead of providing S3 URIs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.Select"> <summary> 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.UpdatePromptResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdatePromptResponse 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.CONN.UpdateCONNPromptCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNPromptCmdlet.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.UpdateCONNQueueHoursOfOperationCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the hours of operation for the specified queue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueHoursOfOperationCmdlet.HoursOfOperationId"> <summary> <para> <para>The identifier for the hours of operation.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueHoursOfOperationCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueHoursOfOperationCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueHoursOfOperationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQueueHoursOfOperationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueHoursOfOperationCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueHoursOfOperationCmdlet.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.UpdateCONNQueueMaxContactCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the maximum number of contacts allowed in a queue before it is considered full. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueMaxContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueMaxContactCmdlet.MaxContact"> <summary> <para> <para>The maximum number of contacts that can be in the queue before it is considered full.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueMaxContactCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueMaxContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQueueMaxContactsResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueMaxContactCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueMaxContactCmdlet.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.UpdateCONNQueueNameCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the name and description of a queue. At least <c>Name</c> or <c>Description</c> must be provided. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.Description"> <summary> <para> <para>The description of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.Name"> <summary> <para> <para>The name of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQueueNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueNameCmdlet.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.UpdateCONNQueueOutboundCallerConfigCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the outbound caller ID name, number, and outbound whisper flow for a specified queue. </para><important><ul><li><para> If the phone number is claimed to a traffic distribution group that was created in the same Region as the Amazon Connect instance where you are calling this API, then you can use a full phone number ARN or a UUID for <c>OutboundCallerIdNumberId</c>. However, if the phone number is claimed to a traffic distribution group that is in one Region, and you are calling this API from an instance in another Amazon Web Services Region that is associated with the traffic distribution group, you must provide a full phone number ARN. If a UUID is provided in this scenario, you will receive a <c>ResourceNotFoundException</c>. </para></li><li><para> Only use the phone number ARN format that doesn't contain <c>instance</c> in the path, for example, <c>arn:aws:connect:us-east-1:1234567890:phone-number/uuid</c>. This is the same ARN format that is returned when you call the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_ListPhoneNumbersV2.html">ListPhoneNumbersV2</a> API. </para></li><li><para> If you plan to use IAM policies to allow/deny access to this API for phone number resources claimed to a traffic distribution group, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security_iam_resource-level-policy-examples.html#allow-deny-queue-actions-replica-region">Allow or Deny queue API actions for phone numbers in a replica Region</a>. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.OutboundCallerConfig_OutboundCallerIdName"> <summary> <para> <para>The caller ID name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.OutboundCallerConfig_OutboundCallerIdNumberId"> <summary> <para> <para>The caller ID number.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.OutboundCallerConfig_OutboundFlowId"> <summary> <para> <para>The outbound whisper flow to be used during an outbound call.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQueueOutboundCallerConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundCallerConfigCmdlet.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.UpdateCONNQueueOutboundEmailConfigCmdlet"> <summary> Updates the outbound email address Id for a specified queue. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundEmailConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundEmailConfigCmdlet.OutboundEmailConfig_OutboundEmailAddressId"> <summary> <para> <para>The identifier of the email address.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundEmailConfigCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundEmailConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQueueOutboundEmailConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundEmailConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueOutboundEmailConfigCmdlet.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.UpdateCONNQueueStatusCmdlet"> <summary> This API is in preview release for Amazon Connect and is subject to change. <para> Updates the status of the queue. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueStatusCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueStatusCmdlet.QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueStatusCmdlet.Status"> <summary> <para> <para>The status of the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQueueStatusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueStatusCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQueueStatusCmdlet.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.UpdateCONNQuickConnectConfigCmdlet"> <summary> Updates the configuration settings for the specified quick connect. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.QueueConfig_ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.UserConfig_ContactFlowId"> <summary> <para> <para>The identifier of the flow.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.PhoneConfig_PhoneNumber"> <summary> <para> <para>The phone number in E.164 format.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.QueueConfig_QueueId"> <summary> <para> <para>The identifier for the queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.QuickConnectId"> <summary> <para> <para>The identifier for the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.QuickConnectConfig_QuickConnectType"> <summary> <para> <para>The type of quick connect. In the Amazon Connect admin website, when you create a quick connect, you are prompted to assign one of the following types: Agent (USER), External (PHONE_NUMBER), or Queue (QUEUE). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.UserConfig_UserId"> <summary> <para> <para>The identifier of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQuickConnectConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectConfigCmdlet.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.UpdateCONNQuickConnectNameCmdlet"> <summary> Updates the name and description of a quick connect. The request accepts the following data in JSON format. At least <c>Name</c> or <c>Description</c> must be provided. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.Description"> <summary> <para> <para>The description of the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.Name"> <summary> <para> <para>The name of the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.QuickConnectId"> <summary> <para> <para>The identifier for the quick connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateQuickConnectNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNQuickConnectNameCmdlet.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.UpdateCONNRoutingProfileAgentAvailabilityTimerCmdlet"> <summary> Whether agents with this routing profile will have their routing order calculated based on <i>time since their last inbound contact</i> or <i>longest idle time</i>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileAgentAvailabilityTimerCmdlet.AgentAvailabilityTimer"> <summary> <para> <para>Whether agents with this routing profile will have their routing order calculated based on <i>time since their last inbound contact</i> or <i>longest idle time</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileAgentAvailabilityTimerCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileAgentAvailabilityTimerCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileAgentAvailabilityTimerCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateRoutingProfileAgentAvailabilityTimerResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileAgentAvailabilityTimerCmdlet.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.UpdateCONNRoutingProfileConcurrencyCmdlet"> <summary> Updates the channels that agents can handle in the Contact Control Panel (CCP) for a routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileConcurrencyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileConcurrencyCmdlet.MediaConcurrency"> <summary> <para> <para>The channels that agents can handle in the Contact Control Panel (CCP).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileConcurrencyCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileConcurrencyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateRoutingProfileConcurrencyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileConcurrencyCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileConcurrencyCmdlet.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.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet"> <summary> Updates the default outbound queue of a routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet.DefaultOutboundQueueId"> <summary> <para> <para>The identifier for the default outbound queue.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateRoutingProfileDefaultOutboundQueueResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileDefaultOutboundQueueCmdlet.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.UpdateCONNRoutingProfileNameCmdlet"> <summary> Updates the name and description of a routing profile. The request accepts the following data in JSON format. At least <c>Name</c> or <c>Description</c> must be provided. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.Description"> <summary> <para> <para>The description of the routing profile. Must not be more than 250 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.Name"> <summary> <para> <para>The name of the routing profile. Must not be more than 127 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateRoutingProfileNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileNameCmdlet.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.UpdateCONNRoutingProfileQueueCmdlet"> <summary> Updates the properties associated with a set of queues for a routing profile. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileQueueCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileQueueCmdlet.QueueConfig"> <summary> <para> <para>The queues to be updated for this routing profile. Queues must first be associated to the routing profile. You can do this using AssociateRoutingProfileQueues.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileQueueCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileQueueCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateRoutingProfileQueuesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileQueueCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRoutingProfileQueueCmdlet.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.UpdateCONNRuleCmdlet"> <summary> Updates a rule for the specified Amazon Connect instance. <para> Use the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/connect-rules-language.html">Rules Function language</a> to code conditions for the rule. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.Action"> <summary> <para> <para>A list of actions to be run when the rule is triggered.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.Function"> <summary> <para> <para>The conditions of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.Name"> <summary> <para> <para>The name of the rule. You can change the name only if <c>TriggerEventSource</c> is one of the following values: <c>OnZendeskTicketCreate</c> | <c>OnZendeskTicketStatusUpdate</c> | <c>OnSalesforceCaseCreate</c></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.PublishStatus"> <summary> <para> <para>The publish status of the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.RuleId"> <summary> <para> <para>A unique identifier for the rule.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateRuleResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RuleId parameter. The -PassThru parameter is deprecated, use -Select '^RuleId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNRuleCmdlet.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.UpdateCONNSecurityProfileCmdlet"> <summary> Updates a security profile. <para> For information about security profiles, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/connect-security-profiles.html">Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. For a mapping of the API name and user interface name of the security profile permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.AllowedAccessControlHierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group that a security profile uses to restrict access to resources in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.AllowedAccessControlTag"> <summary> <para> <para>The list of tags that a security profile uses to restrict access to resources in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.Application"> <summary> <para> <para>A list of the third-party application's metadata.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.Description"> <summary> <para> <para>The description of the security profile.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.HierarchyRestrictedResource"> <summary> <para> <para>The list of resources that a security profile applies hierarchy restrictions to in Amazon Connect. Following are acceptable ResourceNames: <c>User</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.Permission"> <summary> <para> <para>The permissions granted to a security profile. For a list of valid permissions, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-list.html">List of security profile permissions</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.SecurityProfileId"> <summary> <para> <para>The identifier for the security profle.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.TagRestrictedResource"> <summary> <para> <para>The list of resources that a security profile applies tag restrictions to in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateSecurityProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SecurityProfileId parameter. The -PassThru parameter is deprecated, use -Select '^SecurityProfileId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNSecurityProfileCmdlet.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.UpdateCONNTaskTemplateCmdlet"> <summary> Updates details about a specific task template in the specified Amazon Connect instance. This operation does not support partial updates. Instead it does a full update of template content. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.ContactFlowId"> <summary> <para> <para>The identifier of the flow that runs by default when a task is created by referencing this template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Defaults_DefaultFieldValue"> <summary> <para> <para>Default value for the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Description"> <summary> <para> <para>The description of the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Field"> <summary> <para> <para>Fields that are part of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Constraints_InvisibleField"> <summary> <para> <para>Lists the fields that are invisible to agents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Name"> <summary> <para> <para>The name of the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Constraints_ReadOnlyField"> <summary> <para> <para>Lists the fields that are read-only to agents, and cannot be edited.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Constraints_RequiredField"> <summary> <para> <para>Lists the fields that are required to be filled by agents.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.SelfAssignFlowId"> <summary> <para> <para>The ContactFlowId for the flow that will be run if this template is used to create a self-assigned task.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Status"> <summary> <para> <para>Marks a template as <c>ACTIVE</c> or <c>INACTIVE</c> for a task to refer to it. Tasks can only be created from <c>ACTIVE</c> templates. If a template is marked as <c>INACTIVE</c>, then a task that refers to this template cannot be created.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.TaskTemplateId"> <summary> <para> <para>A unique identifier for the task template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.Select"> <summary> 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.UpdateTaskTemplateResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdateTaskTemplateResponse 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.CONN.UpdateCONNTaskTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the TaskTemplateId parameter. The -PassThru parameter is deprecated, use -Select '^TaskTemplateId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTaskTemplateCmdlet.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.UpdateCONNTrafficDistributionCmdlet"> <summary> Updates the traffic distribution for a given traffic distribution group. <note><para> The <c>SignInConfig</c> distribution is available only on a default <c>TrafficDistributionGroup</c> (see the <c>IsDefault</c> parameter in the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html">TrafficDistributionGroup</a> data type). If you call <c>UpdateTrafficDistribution</c> with a modified <c>SignInConfig</c> and a non-default <c>TrafficDistributionGroup</c>, an <c>InvalidRequestException</c> is returned. </para></note><para> For more information about updating a traffic distribution group, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/update-telephony-traffic-distribution.html">Update telephony traffic distribution across Amazon Web Services Regions </a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.AgentConfig_Distribution"> <summary> <para> <para>Information about traffic distributions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.SignInConfig_Distribution"> <summary> <para> <para>Information about traffic distributions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.TelephonyConfig_Distribution"> <summary> <para> <para>Information about traffic distributions.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.Id"> <summary> <para> <para>The identifier of the traffic distribution group. This can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. The ARN must be provided if the call is from the replicated Region. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateTrafficDistributionResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNTrafficDistributionCmdlet.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 specified user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserHierarchyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </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.UpdateCONNUserHierarchyGroupNameCmdlet"> <summary> Updates the name of the user hierarchy group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyGroupNameCmdlet.HierarchyGroupId"> <summary> <para> <para>The identifier of the hierarchy group.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyGroupNameCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyGroupNameCmdlet.Name"> <summary> <para> <para>The name of the hierarchy group. Must not be more than 100 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyGroupNameCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserHierarchyGroupNameResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyGroupNameCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyGroupNameCmdlet.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.UpdateCONNUserHierarchyStructureCmdlet"> <summary> Updates the user hierarchy structure: add, remove, and rename user hierarchy levels. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.LevelFive_Name"> <summary> <para> <para>The name of the user hierarchy level. Must not be more than 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.LevelFour_Name"> <summary> <para> <para>The name of the user hierarchy level. Must not be more than 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.LevelOne_Name"> <summary> <para> <para>The name of the user hierarchy level. Must not be more than 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.LevelThree_Name"> <summary> <para> <para>The name of the user hierarchy level. Must not be more than 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.LevelTwo_Name"> <summary> <para> <para>The name of the user hierarchy level. Must not be more than 50 characters.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserHierarchyStructureResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserHierarchyStructureCmdlet.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. <important><para> We strongly recommend limiting who has the ability to invoke <c>UpdateUserIdentityInfo</c>. Someone with that ability can change the login credentials of other users by changing their email address. This poses a security risk to your organization. They can change the email address of a user to the attacker's email address, and then reset the password through email. For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/security-profile-best-practices.html">Best Practices for Security Profiles</a> in the <i>Amazon Connect Administrator Guide</i>. </para></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.IdentityInfo"> <summary> <para> <para>The identity information for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserIdentityInfoResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserIdentityInfoCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </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 for the specified user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.PhoneConfig"> <summary> <para> <para>Information about phone configuration settings for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserPhoneConfigResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserPhoneConfigCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </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.UpdateCONNUserProficiencyCmdlet"> <summary> Updates the properties associated with the proficiencies of a user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserProficiencyCmdlet.InstanceId"> <summary> <para> <para> The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserProficiencyCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserProficiencyCmdlet.UserProficiency"> <summary> <para> <para>The proficiencies to be updated for the user. Proficiencies must first be associated to the user. You can do this using AssociateUserProficiencies API.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserProficiencyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserProficienciesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserProficiencyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserProficiencyCmdlet.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 the specified user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.RoutingProfileId"> <summary> <para> <para>The identifier of the routing profile for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserRoutingProfileResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserRoutingProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the RoutingProfileId parameter. The -PassThru parameter is deprecated, use -Select '^RoutingProfileId' instead. This parameter will be removed in a future version. </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> Assigns the specified security profiles to the specified user. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.SecurityProfileId"> <summary> <para> <para>The identifiers of the security profiles for the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateUserSecurityProfilesResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNUserSecurityProfileCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </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> <member name="T:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet"> <summary> Updates the view content of the given view identifier in the specified Amazon Connect instance. <para> It performs content validation if <c>Status</c> is set to <c>SAVED</c> and performs full content validation if <c>Status</c> is <c>PUBLISHED</c>. Note that the <c>$SAVED</c> alias' content will always be updated, but the <c>$LATEST</c> alias' content will only be updated if <c>Status</c> is <c>PUBLISHED</c>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.Content_Action"> <summary> <para> <para>A list of possible actions from the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.Status"> <summary> <para> <para>Indicates the view status as either <c>SAVED</c> or <c>PUBLISHED</c>. The <c>PUBLISHED</c> status will initiate validation on the content.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.Content_Template"> <summary> <para> <para>The view template representing the structure of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.ViewId"> <summary> <para> <para>The identifier of the view. Both <c>ViewArn</c> and <c>ViewId</c> can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'View'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateViewContentResponse). Specifying the name of a property of type Amazon.Connect.Model.UpdateViewContentResponse 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.CONN.UpdateCONNViewContentCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewContentCmdlet.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.UpdateCONNViewMetadataCmdlet"> <summary> Updates the view metadata. Note that either <c>Name</c> or <c>Description</c> must be provided. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.Description"> <summary> <para> <para>The description of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.Name"> <summary> <para> <para>The name of the view.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.ViewId"> <summary> <para> <para>The identifier of the view. Both <c>ViewArn</c> and <c>ViewId</c> can be used.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.UpdateViewMetadataResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.UpdateCONNViewMetadataCmdlet.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.WriteCONNUserContactCmdlet"> <summary> Dismisses contacts from an agent’s CCP and returns the agent to an available state, which allows the agent to receive a new routed contact. Contacts can only be dismissed if they are in a <c>MISSED</c>, <c>ERROR</c>, <c>ENDED</c>, or <c>REJECTED</c> state in the <a href="https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html">Agent Event Stream</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserContactCmdlet.ContactId"> <summary> <para> <para>The identifier of the contact.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserContactCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserContactCmdlet.UserId"> <summary> <para> <para>The identifier of the user account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserContactCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.DismissUserContactResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserContactCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserContactCmdlet.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.WriteCONNUserStatusCmdlet"> <summary> Changes the current status of a user or agent in Amazon Connect. If the agent is currently handling a contact, this sets the agent's next status. <para> For more information, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/metrics-agent-status.html">Agent status</a> and <a href="https://docs.aws.amazon.com/connect/latest/adminguide/set-next-status.html">Set your next status</a> in the <i>Amazon Connect Administrator Guide</i>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserStatusCmdlet.AgentStatusId"> <summary> <para> <para>The identifier of the agent status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserStatusCmdlet.InstanceId"> <summary> <para> <para>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserStatusCmdlet.UserId"> <summary> <para> <para>The identifier of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserStatusCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Connect.Model.PutUserStatusResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserStatusCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the UserId parameter. The -PassThru parameter is deprecated, use -Select '^UserId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CONN.WriteCONNUserStatusCmdlet.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> |