AWS.Tools.ConnectCases.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.ConnectCases</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.AddCCASResourceTagCmdlet"> <summary> Adds tags to a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.AddCCASResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.AddCCASResourceTagCmdlet.Tag"> <summary> <para> <para>A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.AddCCASResourceTagCmdlet.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.ConnectCases.Model.TagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.AddCCASResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.AddCCASResourceTagCmdlet.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.CCAS.GetCCASCaseCmdlet"> <summary> Returns information about a specific case if it exists. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseCmdlet.CaseId"> <summary> <para> <para>A unique identifier of the case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseCmdlet.Field"> <summary> <para> <para>A list of unique field identifiers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseCmdlet.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.ConnectCases.Model.GetCaseResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.GetCaseResponse 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.CCAS.GetCCASCaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseAuditEventCmdlet"> <summary> Returns the audit history about a specific case if it exists. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseAuditEventCmdlet.CaseId"> <summary> <para> <para>A unique identifier of the case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseAuditEventCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseAuditEventCmdlet.MaxResult"> <summary> <para> <para>The maximum number of audit events to return. The current maximum supported value is 25. This is also the default when no other value is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseAuditEventCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseAuditEventCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'AuditEvents'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.GetCaseAuditEventsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.GetCaseAuditEventsResponse 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.CCAS.GetCCASCaseAuditEventCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseEventConfigurationCmdlet"> <summary> Returns the case event publishing configuration. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseEventConfigurationCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCaseEventConfigurationCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'EventBridge'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.GetCaseEventConfigurationResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.GetCaseEventConfigurationResponse 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.CCAS.GetCCASCaseEventConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCasesForContactListCmdlet"> <summary> Lists cases for a given contact. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCasesForContactListCmdlet.ContactArn"> <summary> <para> <para>A unique identifier of a contact in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCasesForContactListCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCasesForContactListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCasesForContactListCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASCasesForContactListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.ListCasesForContactResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.ListCasesForContactResponse 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.CCAS.GetCCASCasesForContactListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainCmdlet"> <summary> Returns information about a specific domain if it exists. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainCmdlet.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.ConnectCases.Model.GetDomainResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.GetDomainResponse 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.CCAS.GetCCASDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainListCmdlet"> <summary> Lists all cases domains in the Amazon Web Services account. Each list item is a condensed summary object of the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainListCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASDomainListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Domains'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.ListDomainsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.ListDomainsResponse 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.CCAS.GetCCASFieldListCmdlet"> <summary> Lists all fields in a Cases domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldListCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldListCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Fields'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.ListFieldsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.ListFieldsResponse 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.CCAS.GetCCASFieldListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet"> <summary> Lists all of the field options for a field identifier in the domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet.FieldId"> <summary> <para> <para>The unique identifier of a field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet.Value"> <summary> <para> <para>A list of <c>FieldOption</c> values to filter on for <c>ListFieldOptions</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASFieldOptionListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Options'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.ListFieldOptionsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.ListFieldOptionsResponse 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.CCAS.GetCCASFieldOptionListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutCmdlet"> <summary> Returns the details for the requested layout. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutCmdlet.LayoutId"> <summary> <para> <para>The unique identifier of the layout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutCmdlet.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.ConnectCases.Model.GetLayoutResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.GetLayoutResponse 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.CCAS.GetCCASLayoutCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutListCmdlet"> <summary> Lists all layouts in the given cases domain. Each list item is a condensed summary object of the layout. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutListCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutListCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASLayoutListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Layouts'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.ListLayoutsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.ListLayoutsResponse 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.CCAS.GetCCASLayoutListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASResourceTagCmdlet"> <summary> Lists tags for a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASResourceTagCmdlet.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.ConnectCases.Model.ListTagsForResourceResponse). Specifying the name of a property of type Amazon.ConnectCases.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.CCAS.GetCCASResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateCmdlet"> <summary> Returns the details for the requested template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateCmdlet.TemplateId"> <summary> <para> <para>A unique identifier of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateCmdlet.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.ConnectCases.Model.GetTemplateResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.GetTemplateResponse 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.CCAS.GetCCASTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateListCmdlet"> <summary> Lists all of the templates in a Cases domain. Each list item is a condensed summary object of the template. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateListCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateListCmdlet.Status"> <summary> <para> <para>A list of status values to filter on.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateListCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GetCCASTemplateListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Templates'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.ListTemplatesResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.ListTemplatesResponse 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.CCAS.GetCCASTemplateListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASGetFieldCmdlet"> <summary> Returns the description for the list of fields in the request parameters. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASGetFieldCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASGetFieldCmdlet.Field"> <summary> <para> <para>A list of unique field identifiers. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASGetFieldCmdlet.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.ConnectCases.Model.BatchGetFieldResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.BatchGetFieldResponse 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.CCAS.GroupCCASGetFieldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASGetFieldCmdlet.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.CCAS.GroupCCASPutFieldOptionCmdlet"> <summary> Creates and updates a set of field options for a single select field in a Cases domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASPutFieldOptionCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASPutFieldOptionCmdlet.FieldId"> <summary> <para> <para>The unique identifier of a field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASPutFieldOptionCmdlet.Option"> <summary> <para> <para>A list of <c>FieldOption</c> objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASPutFieldOptionCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Errors'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.BatchPutFieldOptionsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.BatchPutFieldOptionsResponse 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.CCAS.GroupCCASPutFieldOptionCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.GroupCCASPutFieldOptionCmdlet.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.CCAS.NewCCASCaseCmdlet"> <summary> <note><para> If you provide a value for <c>PerformedBy.UserArn</c> you must also have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">connect:DescribeUser</a> permission on the User ARN resource that you provide </para></note><pre><c> <p>Creates a case in the specified Cases domain. Case system and custom fields are taken as an array id/value pairs with a declared data types.</p> <p>The following fields are required when creating a case:</p> <ul> <li> <p> <code>customer_id</code> - You must provide the full customer profile ARN in this format: <code>arn:aws:profile:your_AWS_Region:your_AWS_account ID:domains/your_profiles_domain_name/profiles/profile_ID</code> </p> </li> <li> <p> <code>title</code> </p> </li> </ul> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASCaseCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASCaseCmdlet.Field"> <summary> <para> <para>An array of objects with field ID (matching ListFields/DescribeField) and value union data.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASCaseCmdlet.TemplateId"> <summary> <para> <para>A unique identifier of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASCaseCmdlet.PerformedBy_UserArn"> <summary> <para> <para>Represents the Amazon Connect ARN of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASCaseCmdlet.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.CCAS.NewCCASCaseCmdlet.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.ConnectCases.Model.CreateCaseResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateCaseResponse 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.CCAS.NewCCASCaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASCaseCmdlet.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.CCAS.NewCCASDomainCmdlet"> <summary> Amazon.ConnectCases.IAmazonConnectCases.CreateDomain </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASDomainCmdlet.Name"> <summary> <para> <para>The name for your Cases domain. It must be unique for your Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASDomainCmdlet.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.ConnectCases.Model.CreateDomainResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateDomainResponse 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.CCAS.NewCCASDomainCmdlet.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.CCAS.NewCCASDomainCmdlet.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.CCAS.NewCCASFieldCmdlet"> <summary> Creates a field in the Cases domain. This field is used to define the case object model (that is, defines what data can be captured on cases) in a Cases domain. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASFieldCmdlet.Description"> <summary> <para> <para>The description of the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASFieldCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASFieldCmdlet.Name"> <summary> <para> <para>The name of the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASFieldCmdlet.Type"> <summary> <para> <para>Defines the data type, some system constraints, and default display of the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASFieldCmdlet.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.ConnectCases.Model.CreateFieldResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateFieldResponse 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.CCAS.NewCCASFieldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASFieldCmdlet.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.CCAS.NewCCASLayoutCmdlet"> <summary> Creates a layout in the Cases domain. Layouts define the following configuration in the top section and More Info tab of the Cases user interface: <ul><li><para> Fields to display to the users </para></li><li><para> Field ordering </para></li></ul><note><para> Title and Status fields cannot be part of layouts since they are not configurable. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASLayoutCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASLayoutCmdlet.Name"> <summary> <para> <para>The name of the layout. It must be unique for the Cases domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASLayoutCmdlet.MoreInfo_Section"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASLayoutCmdlet.TopPanel_Section"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASLayoutCmdlet.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.ConnectCases.Model.CreateLayoutResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateLayoutResponse 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.CCAS.NewCCASLayoutCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASLayoutCmdlet.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.CCAS.NewCCASRelatedItemCmdlet"> <summary> Amazon.ConnectCases.IAmazonConnectCases.CreateRelatedItem </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.Comment_Body"> <summary> <para> <para>Text in the body of a <c>Comment</c> on a case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.CaseId"> <summary> <para> <para>A unique identifier of the case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.Contact_ContactArn"> <summary> <para> <para>A unique identifier of a contact in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.Comment_ContentType"> <summary> <para> <para>Type of the text in the box of a <c>Comment</c> on a case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.File_FileArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of a File in Amazon Connect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.Type"> <summary> <para> <para>The type of a related item.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.PerformedBy_UserArn"> <summary> <para> <para>Represents the Amazon Connect ARN of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.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.ConnectCases.Model.CreateRelatedItemResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateRelatedItemResponse 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.CCAS.NewCCASRelatedItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASRelatedItemCmdlet.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.CCAS.NewCCASTemplateCmdlet"> <summary> Creates a template in the Cases domain. This template is used to define the case object model (that is, to define what data can be captured on cases) in a Cases domain. A template must have a unique name within a domain, and it must reference existing field IDs and layout IDs. Additionally, multiple fields with same IDs are not allowed within the same Template. A template can be either Active or Inactive, as indicated by its status. Inactive templates cannot be used to create cases. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.LayoutConfiguration_DefaultLayout"> <summary> <para> <para> Unique identifier of a layout. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.Description"> <summary> <para> <para>A brief description of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.Name"> <summary> <para> <para>A name for the template. It must be unique per domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.RequiredField"> <summary> <para> <para>A list of fields that must contain a value for a case to be successfully created with this template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.Status"> <summary> <para> <para>The status of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.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.ConnectCases.Model.CreateTemplateResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.CreateTemplateResponse 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.CCAS.NewCCASTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.NewCCASTemplateCmdlet.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.CCAS.RemoveCCASDomainCmdlet"> <summary> Deletes a Cases domain. <pre><c> <note> <p>After deleting your domain you must disassociate the deleted domain from your Amazon Connect instance with another API call before being able to use Cases again with this Amazon Connect instance. See <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteIntegrationAssociation.html">DeleteIntegrationAssociation</a>.</p> </note> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASDomainCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASDomainCmdlet.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.ConnectCases.Model.DeleteDomainResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASDomainCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASDomainCmdlet.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.CCAS.RemoveCCASFieldCmdlet"> <summary> Deletes a field from a cases template. You can delete up to 100 fields per domain. <para> After a field is deleted: </para><ul><li><para> You can still retrieve the field by calling <c>BatchGetField</c>. </para></li><li><para> You cannot update a deleted field by calling <c>UpdateField</c>; it throws a <c>ValidationException</c>. </para></li><li><para> Deleted fields are not included in the <c>ListFields</c> response. </para></li><li><para> Calling <c>CreateCase</c> with a deleted field throws a <c>ValidationException</c> denoting which field IDs in the request have been deleted. </para></li><li><para> Calling <c>GetCase</c> with a deleted field ID returns the deleted field's value if one exists. </para></li><li><para> Calling <c>UpdateCase</c> with a deleted field ID throws a <c>ValidationException</c> if the case does not already contain a value for the deleted field. Otherwise it succeeds, allowing you to update or remove (using <c>emptyValue: {}</c>) the field's value from the case. </para></li><li><para><c>GetTemplate</c> does not return field IDs for deleted fields. </para></li><li><para><c>GetLayout</c> does not return field IDs for deleted fields. </para></li><li><para> Calling <c>SearchCases</c> with the deleted field ID as a filter returns any cases that have a value for the deleted field that matches the filter criteria. </para></li><li><para> Calling <c>SearchCases</c> with a <c>searchTerm</c> value that matches a deleted field's value on a case returns the case in the response. </para></li><li><para> Calling <c>BatchPutFieldOptions</c> with a deleted field ID throw a <c>ValidationException</c>. </para></li><li><para> Calling <c>GetCaseEventConfiguration</c> does not return field IDs for deleted fields. </para></li></ul> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASFieldCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASFieldCmdlet.FieldId"> <summary> <para> <para>Unique identifier of the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASFieldCmdlet.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.ConnectCases.Model.DeleteFieldResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASFieldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASFieldCmdlet.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.CCAS.RemoveCCASLayoutCmdlet"> <summary> Deletes a layout from a cases template. You can delete up to 100 layouts per domain. <pre><c> <p>After a layout is deleted:</p> <ul> <li> <p>You can still retrieve the layout by calling <code>GetLayout</code>.</p> </li> <li> <p>You cannot update a deleted layout by calling <code>UpdateLayout</code>; it throws a <code>ValidationException</code>.</p> </li> <li> <p>Deleted layouts are not included in the <code>ListLayouts</code> response.</p> </li> </ul> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASLayoutCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASLayoutCmdlet.LayoutId"> <summary> <para> <para>The unique identifier of the layout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASLayoutCmdlet.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.ConnectCases.Model.DeleteLayoutResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASLayoutCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASLayoutCmdlet.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.CCAS.RemoveCCASResourceTagCmdlet"> <summary> Untags a resource. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASResourceTagCmdlet.Arn"> <summary> <para> <para>The Amazon Resource Name (ARN)</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASResourceTagCmdlet.TagKey"> <summary> <para> <para>List of tag keys.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASResourceTagCmdlet.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.ConnectCases.Model.UntagResourceResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASResourceTagCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASResourceTagCmdlet.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.CCAS.RemoveCCASTemplateCmdlet"> <summary> Deletes a cases template. You can delete up to 100 templates per domain. <pre><c> <p>After a cases template is deleted:</p> <ul> <li> <p>You can still retrieve the template by calling <code>GetTemplate</code>.</p> </li> <li> <p>You cannot update the template. </p> </li> <li> <p>You cannot create a case by using the deleted template.</p> </li> <li> <p>Deleted templates are not included in the <code>ListTemplates</code> response.</p> </li> </ul> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASTemplateCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASTemplateCmdlet.TemplateId"> <summary> <para> <para>A unique identifier of a template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASTemplateCmdlet.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.ConnectCases.Model.DeleteTemplateResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.RemoveCCASTemplateCmdlet.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.CCAS.SearchCCASCaseCmdlet"> <summary> Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents. <note><para> For <c>customer_id</c> you must provide the full customer profile ARN in this format: <c> arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID</c>. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.Field"> <summary> <para> <para>The list of field identifiers to be returned as part of the response.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.Filter"> <summary> <para> <para>A list of filter objects.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.SearchTerm"> <summary> <para> <para>A word or phrase used to perform a quick search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.Sort"> <summary> <para> <para>A list of sorts where each sort specifies a field and their sort order to be applied to the results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.MaxResult"> <summary> <para> <para>The maximum number of cases to return. The current maximum supported value is 25. This is also the default value when no other value is provided.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Cases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.SearchCasesResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.SearchCasesResponse 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.CCAS.SearchCCASCaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASCaseCmdlet.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.CCAS.SearchCCASRelatedItemCmdlet"> <summary> Searches for related items that are associated with a case. <note><para> If no filters are provided, this returns all related items associated with a case. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.CaseId"> <summary> <para> <para>A unique identifier of the case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.Filter"> <summary> <para> <para>The list of types of related items and their parameters to use for filtering.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return per page.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'RelatedItems'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ConnectCases.Model.SearchRelatedItemsResponse). Specifying the name of a property of type Amazon.ConnectCases.Model.SearchRelatedItemsResponse 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.CCAS.SearchCCASRelatedItemCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.SearchCCASRelatedItemCmdlet.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.CCAS.UpdateCCASCaseCmdlet"> <summary> <note><para> If you provide a value for <c>PerformedBy.UserArn</c> you must also have <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribeUser.html">connect:DescribeUser</a> permission on the User ARN resource that you provide </para></note><pre><c> <p>Updates the values of fields on a case. Fields to be updated are received as an array of id/value pairs identical to the <code>CreateCase</code> input .</p> <p>If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.</p> </c></pre> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.CaseId"> <summary> <para> <para>A unique identifier of the case.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.Field"> <summary> <para> <para>An array of objects with <c>fieldId</c> (matching ListFields/DescribeField) and value union data, structured identical to <c>CreateCase</c>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.PerformedBy_UserArn"> <summary> <para> <para>Represents the Amazon Connect ARN of the user.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.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.ConnectCases.Model.UpdateCaseResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASCaseCmdlet.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.CCAS.UpdateCCASFieldCmdlet"> <summary> Updates the properties of an existing field. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.Description"> <summary> <para> <para>The description of a field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.FieldId"> <summary> <para> <para>The unique identifier of a field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.Name"> <summary> <para> <para>The name of the field.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.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.ConnectCases.Model.UpdateFieldResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASFieldCmdlet.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.CCAS.UpdateCCASLayoutCmdlet"> <summary> Updates the attributes of an existing layout. <para> If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. </para><para> A <c>ValidationException</c> is returned when you add non-existent <c>fieldIds</c> to a layout. </para><note><para> Title and Status fields cannot be part of layouts because they are not configurable. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.LayoutId"> <summary> <para> <para>The unique identifier of the layout.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.Name"> <summary> <para> <para>The name of the layout. It must be unique per domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.MoreInfo_Section"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.TopPanel_Section"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.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.ConnectCases.Model.UpdateLayoutResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASLayoutCmdlet.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.CCAS.UpdateCCASTemplateCmdlet"> <summary> Updates the attributes of an existing template. The template attributes that can be modified include <c>name</c>, <c>description</c>, <c>layoutConfiguration</c>, <c>requiredFields</c>, and <c>status</c>. At least one of these attributes must not be null. If a null value is provided for a given attribute, that attribute is ignored and its current value is preserved. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.LayoutConfiguration_DefaultLayout"> <summary> <para> <para> Unique identifier of a layout. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.Description"> <summary> <para> <para>A brief description of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.Name"> <summary> <para> <para>The name of the template. It must be unique per domain.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.RequiredField"> <summary> <para> <para>A list of fields that must contain a value for a case to be successfully created with this template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.Status"> <summary> <para> <para>The status of the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.TemplateId"> <summary> <para> <para>A unique identifier for the template.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.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.ConnectCases.Model.UpdateTemplateResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.UpdateCCASTemplateCmdlet.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.CCAS.WriteCCASCaseEventConfigurationCmdlet"> <summary> Adds case event publishing configuration. For a complete list of fields you can add to the event message, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/case-fields.html">Create case fields</a> in the <i>Amazon Connect Administrator Guide</i> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.DomainId"> <summary> <para> <para>The unique identifier of the Cases domain. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.EventBridge_Enabled"> <summary> <para> <para>Indicates whether the to broadcast case event data to the customer.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.CaseData_Field"> <summary> <para> <para>List of field identifiers.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.RelatedItemData_IncludeContent"> <summary> <para> <para>Details of what related item data is published through the case event stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.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.ConnectCases.Model.PutCaseEventConfigurationResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the DomainId parameter. The -PassThru parameter is deprecated, use -Select '^DomainId' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CCAS.WriteCCASCaseEventConfigurationCmdlet.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> |