@aws-sdk/client-connect 3.883.0 → 3.885.0

package/dist-types/commands/UpdatePredefinedAttributeCommand.d.ts

@@ -27,10 +27,29 @@ declare const UpdatePredefinedAttributeCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>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>.</p>
+ * <p>Updates a predefined attribute for the specified Amazon Connect instance.  A <i>predefined
+ *     attribute</i> is made up of a name and a value.</p>
+ *          <p>For the predefined attributes per instance quota, see <a href="https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#connect-quotas">Amazon Connect quotas</a>.</p>
+ *          <p>
+ *             <b>Use cases</b>
+ *          </p>
+ *          <p>Following are common uses cases for this API:</p>
+ *          <ul>
+ *             <li>
+ *                <p>Update routing proficiency (for example, agent certification) that has
+ *      predefined values (for example, a list of possible certifications). 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>.</p>
+ *             </li>
+ *             <li>
+ *                <p>Update an attribute for business unit name that has a list of predefined business unit
+ *        names used in your organization. This is a use case where information for a contact varies between transfers or conferences. For more information, see
+ *        <a href="https://docs.aws.amazon.com/connect/latest/adminguide/use-contact-segment-attributes.html">Use contact segment attributes</a>.</p>
+ *             </li>
+ *          </ul>
+ *          <p>
+ *             <b>Endpoints</b>: See <a href="https://docs.aws.amazon.com/general/latest/gr/connect_region.html">Amazon Connect endpoints and
+ *     quotas</a>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -45,6 +64,12 @@ declare const UpdatePredefinedAttributeCommand_base: {
  *       "STRING_VALUE",
  *     ],
  *   },
+ *   Purposes: [ // PredefinedAttributePurposeNameList
+ *     "STRING_VALUE",
+ *   ],
+ *   AttributeConfiguration: { // InputPredefinedAttributeConfiguration
+ *     EnableValueValidationOnAssociation: true || false,
+ *   },
  * };
  * const command = new UpdatePredefinedAttributeCommand(input);
  * const response = await client.send(command);

package/dist-types/models/models_0.d.ts

@@ -4039,6 +4039,20 @@ export interface CreatePersistentContactAssociationResponse {
      */
     ContinuedFromContactId?: string | undefined;
 }
+/**
+ * <p>Custom metadata that is associated to predefined attributes to control behavior in upstream
+ *    services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
+ * @public
+ */
+export interface InputPredefinedAttributeConfiguration {
+    /**
+     * <p>When this parameter is set to true, Amazon Connect enforces strict validation on the
+     *    specific values, if the values are predefined in attributes. The contact will store only valid
+     *    and predefined values for the predefined attribute key.</p>
+     * @public
+     */
+    EnableValueValidationOnAssociation?: boolean | undefined;
+}
 /**
  * <p>Information about values of a predefined attribute.</p>
  * @public
@@ -4088,7 +4102,19 @@ export interface CreatePredefinedAttributeRequest {
      * <p> The values of the predefined attribute. </p>
      * @public
      */
-    Values: PredefinedAttributeValues | undefined;
+    Values?: PredefinedAttributeValues | undefined;
+    /**
+     * <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
+     * @public
+     */
+    Purposes?: string[] | undefined;
+    /**
+     * <p>Custom metadata that is associated to predefined attributes to control behavior
+     * in upstream services, such as controlling
+     * how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
+     * @public
+     */
+    AttributeConfiguration?: InputPredefinedAttributeConfiguration | undefined;
 }
 /**
  * @public
@@ -6386,21 +6412,6 @@ export interface DeleteInstanceRequest {
      */
     ClientToken?: string | undefined;
 }
-/**
- * @public
- */
-export interface DeleteIntegrationAssociationRequest {
-    /**
-     * <p>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.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The identifier for the integration association.</p>
-     * @public
-     */
-    IntegrationAssociationId: string | undefined;
-}
 /**
  * @internal
  */

package/dist-types/models/models_1.d.ts

@@ -1,6 +1,21 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
-import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, StorageType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
+import { AgentAvailabilityTimer, AgentConfig, AgentContactReference, AgentQualityMetrics, AgentsCriteria, AgentStatus, AgentStatusIdentifier, AgentStatusReference, AgentStatusSummary, AgentStatusType, AnalyticsDataAssociationResult, AudioQualityMetricsInfo, Channel, ContactFlowStatus, ContactFlowType, ContactInitiationMethod, ContactState, CreatedByInfo, DeviceInfo, DirectoryType, Distribution, EndpointType, FileStatusType, FileUseCaseType, FlowAssociationResourceType, FlowAssociationSummary, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, LexBot, LexV2Bot, ListFlowAssociationResourceType, MediaConcurrency, OutboundCallerConfig, OutboundEmailConfig, OverrideTimeSlice, ParticipantCapabilities, PredefinedAttributeValues, QueueReference, QuickConnectConfig, ReferenceStatus, ReferenceType, RoutingProfileQueueReference, RuleAction, RulePublishStatus, RuleTriggerEventSource, StorageType, TaskTemplateConstraints, TaskTemplateDefaults, TaskTemplateField, TaskTemplateStatus, UserIdentityInfo, UserPhoneConfig, View, VocabularyLanguageCode, VocabularyState } from "./models_0";
+/**
+ * @public
+ */
+export interface DeleteIntegrationAssociationRequest {
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The identifier for the integration association.</p>
+     * @public
+     */
+    IntegrationAssociationId: string | undefined;
+}
 /**
  * @public
  */
@@ -2431,6 +2446,26 @@ export interface DescribePredefinedAttributeRequest {
      */
     Name: string | undefined;
 }
+/**
+ * <p>Custom metadata that is associated to predefined attributes to control behavior in upstream
+ *    services, such as controlling how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
+ * @public
+ */
+export interface PredefinedAttributeConfiguration {
+    /**
+     * <p>When this parameter is set to true, Amazon Connect enforces strict validation on the
+     *    specific values, if the values are predefined in attributes. The contact will store only valid
+     *    and predefined values for teh predefined attribute key.</p>
+     * @public
+     */
+    EnableValueValidationOnAssociation?: boolean | undefined;
+    /**
+     * <p>A boolean flag used to indicate whether a predefined attribute should be displayed in the
+     *    Amazon Connect admin website.</p>
+     * @public
+     */
+    IsReadOnly?: boolean | undefined;
+}
 /**
  * <p>Information about a predefined attribute.</p>
  * @public
@@ -2446,6 +2481,18 @@ export interface PredefinedAttribute {
      * @public
      */
     Values?: PredefinedAttributeValues | undefined;
+    /**
+     * <p>Values that enable you to categorize your predefined attributes. You can use them in custom UI elements across the Amazon Connect admin website.</p>
+     * @public
+     */
+    Purposes?: string[] | undefined;
+    /**
+     * <p>Custom metadata that is associated to predefined attributes to control behavior
+     * in upstream services, such as controlling
+     * how a predefined attribute should be displayed in the Amazon Connect admin website.</p>
+     * @public
+     */
+    AttributeConfiguration?: PredefinedAttributeConfiguration | undefined;
     /**
      * <p>Last modified time.</p>
      * @public
@@ -9230,52 +9277,6 @@ export interface ListInstanceStorageConfigsRequest {
      */
     MaxResults?: number | undefined;
 }
-/**
- * @public
- */
-export interface ListInstanceStorageConfigsResponse {
-    /**
-     * <p>A valid storage type.</p>
-     * @public
-     */
-    StorageConfigs?: InstanceStorageConfig[] | undefined;
-    /**
-     * <p>If there are additional results, this is the token for the next set of results.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-}
-/**
- * @public
- */
-export interface ListIntegrationAssociationsRequest {
-    /**
-     * <p>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.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The integration type.</p>
-     * @public
-     */
-    IntegrationType?: IntegrationType | undefined;
-    /**
-     * <p>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.</p>
-     * @public
-     */
-    NextToken?: string | undefined;
-    /**
-     * <p>The maximum number of results to return per page.</p>
-     * @public
-     */
-    MaxResults?: number | undefined;
-    /**
-     * <p>The Amazon Resource Name (ARN) of the integration.</p>
-     * @public
-     */
-    IntegrationArn?: string | undefined;
-}
 /**
  * @internal
  */

package/dist-types/models/models_2.d.ts

@@ -2,6 +2,52 @@ import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-cli
 import { ConnectServiceException as __BaseException } from "./ConnectServiceException";
 import { ActionSummary, AgentHierarchyGroups, AgentStatus, AgentStatusState, AllowedCapabilities, Application, Channel, ContactInitiationMethod, ControlPlaneAttributeFilter, CreatedByInfo, EventSourceName, FileStatusType, FileUseCaseType, HoursOfOperationConfig, HoursOfOperationOverrideConfig, InstanceStorageConfig, InstanceStorageResourceType, IntegrationType, LexBot, MonitorCapability, ParticipantRole, QuickConnectType, Reference, RehydrationType, RulePublishStatus, SourceType, StringComparisonType, StringCondition, TagCondition, TaskTemplateStatus, UseCaseType, UserPhoneConfig, UserProficiency, ViewStatus, ViewType, VocabularyLanguageCode, VocabularyState } from "./models_0";
 import { ContactFlow, ContactFlowModule, ContactFlowModuleState, ContactFlowState, EvaluationAnswerData, EvaluationNote, HierarchyGroup, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationOverride, InstanceAttributeType, PhoneNumberCountryCode, PhoneNumberType, PredefinedAttribute, Prompt, Queue, QuickConnect, RoutingProfile, SortOrder, TrafficDistributionGroupStatus } from "./models_1";
+/**
+ * @public
+ */
+export interface ListInstanceStorageConfigsResponse {
+    /**
+     * <p>A valid storage type.</p>
+     * @public
+     */
+    StorageConfigs?: InstanceStorageConfig[] | undefined;
+    /**
+     * <p>If there are additional results, this is the token for the next set of results.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+}
+/**
+ * @public
+ */
+export interface ListIntegrationAssociationsRequest {
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    InstanceId: string | undefined;
+    /**
+     * <p>The integration type.</p>
+     * @public
+     */
+    IntegrationType?: IntegrationType | undefined;
+    /**
+     * <p>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.</p>
+     * @public
+     */
+    NextToken?: string | undefined;
+    /**
+     * <p>The maximum number of results to return per page.</p>
+     * @public
+     */
+    MaxResults?: number | undefined;
+    /**
+     * <p>The Amazon Resource Name (ARN) of the integration.</p>
+     * @public
+     */
+    IntegrationArn?: string | undefined;
+}
 /**
  * <p>Contains summary information about the associated AppIntegrations.</p>
  * @public
@@ -6749,47 +6795,6 @@ export interface UpdateInstanceStorageConfigRequest {
      */
     ClientToken?: string | undefined;
 }
-/**
- * @public
- */
-export interface UpdateParticipantAuthenticationRequest {
-    /**
-     * <p>The <code>state</code> query parameter that was provided by Cognito in the
-     *     <code>redirectUri</code>. This will also match the <code>state</code> parameter provided in the
-     *     <code>AuthenticationUrl</code> from the <a href="https://docs.aws.amazon.com/connect/latest/APIReference/API_GetAuthenticationUrl.html">GetAuthenticationUrl</a>
-     *    response.</p>
-     * @public
-     */
-    State: string | undefined;
-    /**
-     * <p>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.</p>
-     * @public
-     */
-    InstanceId: string | undefined;
-    /**
-     * <p>The <code>code</code> query parameter provided by Cognito in the
-     *    <code>redirectUri</code>.</p>
-     * @public
-     */
-    Code?: string | undefined;
-    /**
-     * <p>The <code>error</code> query parameter provided by Cognito in the
-     *    <code>redirectUri</code>.</p>
-     * @public
-     */
-    Error?: string | undefined;
-    /**
-     * <p>The <code>error_description</code> parameter provided by Cognito in the
-     *     <code>redirectUri</code>.</p>
-     * @public
-     */
-    ErrorDescription?: string | undefined;
-}
-/**
- * @public
- */
-export interface UpdateParticipantAuthenticationResponse {
-}
 /**
  * @internal
  */
@@ -6846,6 +6851,14 @@ export declare const SearchCriteriaFilterSensitiveLog: (obj: SearchCriteria) =>
  * @internal
  */
 export declare const SearchContactsRequestFilterSensitiveLog: (obj: SearchContactsRequest) => any;
+/**
+ * @internal
+ */
+export declare const ContactSearchSummaryFilterSensitiveLog: (obj: ContactSearchSummary) => any;
+/**
+ * @internal
+ */
+export declare const SearchContactsResponseFilterSensitiveLog: (obj: SearchContactsResponse) => any;
 /**
  * @internal
  */
@@ -6926,7 +6939,3 @@ export declare const StartWebRTCContactResponseFilterSensitiveLog: (obj: StartWe
  * @internal
  */
 export declare const UpdateEmailAddressMetadataRequestFilterSensitiveLog: (obj: UpdateEmailAddressMetadataRequest) => any;
-/**
- * @internal
- */
-export declare const UpdateParticipantAuthenticationRequestFilterSensitiveLog: (obj: UpdateParticipantAuthenticationRequest) => any;