Associates an agent with a traffic distribution group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, AssociateTrafficDistributionGroupUserCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, AssociateTrafficDistributionGroupUserCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // AssociateTrafficDistributionGroupUserRequest + * TrafficDistributionGroupId: "STRING_VALUE", // required + * UserId: "STRING_VALUE", // required + * InstanceId: "STRING_VALUE", // required + * }; + * const command = new AssociateTrafficDistributionGroupUserCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param AssociateTrafficDistributionGroupUserCommandInput - {@link AssociateTrafficDistributionGroupUserCommandInput} + * @returns {@link AssociateTrafficDistributionGroupUserCommandOutput} + * @see {@link AssociateTrafficDistributionGroupUserCommandInput} for command's `input` shape. + * @see {@link AssociateTrafficDistributionGroupUserCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient permissions to perform this action.
+ * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceConflictException} (client fault) + *A resource already has that name.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + */ +export class AssociateTrafficDistributionGroupUserCommand extends $Command< + AssociateTrafficDistributionGroupUserCommandInput, + AssociateTrafficDistributionGroupUserCommandOutput, + ConnectClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: AssociateTrafficDistributionGroupUserCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackDisassociates an agent from a traffic distribution group.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, DisassociateTrafficDistributionGroupUserCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, DisassociateTrafficDistributionGroupUserCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // DisassociateTrafficDistributionGroupUserRequest + * TrafficDistributionGroupId: "STRING_VALUE", // required + * UserId: "STRING_VALUE", // required + * InstanceId: "STRING_VALUE", // required + * }; + * const command = new DisassociateTrafficDistributionGroupUserCommand(input); + * const response = await client.send(command); + * // {}; + * + * ``` + * + * @param DisassociateTrafficDistributionGroupUserCommandInput - {@link DisassociateTrafficDistributionGroupUserCommandInput} + * @returns {@link DisassociateTrafficDistributionGroupUserCommandOutput} + * @see {@link DisassociateTrafficDistributionGroupUserCommandInput} for command's `input` shape. + * @see {@link DisassociateTrafficDistributionGroupUserCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient permissions to perform this action.
+ * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceConflictException} (client fault) + *A resource already has that name.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + */ +export class DisassociateTrafficDistributionGroupUserCommand extends $Command< + DisassociateTrafficDistributionGroupUserCommandInput, + DisassociateTrafficDistributionGroupUserCommandOutput, + ConnectClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: DisassociateTrafficDistributionGroupUserCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackFor more information about phone numbers, see Set Up Phone Numbers for Your * Contact Center in the Amazon Connect Administrator * Guide.
+ *When given an instance ARN, ListPhoneNumbersV2 returns only the phone
+ * numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers
+ * claimed to the traffic distribution group.
Lists traffic distribution group users.
+ * @example + * Use a bare-bones client and the command you need to make an API call. + * ```javascript + * import { ConnectClient, ListTrafficDistributionGroupUsersCommand } from "@aws-sdk/client-connect"; // ES Modules import + * // const { ConnectClient, ListTrafficDistributionGroupUsersCommand } = require("@aws-sdk/client-connect"); // CommonJS import + * const client = new ConnectClient(config); + * const input = { // ListTrafficDistributionGroupUsersRequest + * TrafficDistributionGroupId: "STRING_VALUE", // required + * MaxResults: Number("int"), + * NextToken: "STRING_VALUE", + * }; + * const command = new ListTrafficDistributionGroupUsersCommand(input); + * const response = await client.send(command); + * // { // ListTrafficDistributionGroupUsersResponse + * // NextToken: "STRING_VALUE", + * // TrafficDistributionGroupUserSummaryList: [ // TrafficDistributionGroupUserSummaryList + * // { // TrafficDistributionGroupUserSummary + * // UserId: "STRING_VALUE", + * // }, + * // ], + * // }; + * + * ``` + * + * @param ListTrafficDistributionGroupUsersCommandInput - {@link ListTrafficDistributionGroupUsersCommandInput} + * @returns {@link ListTrafficDistributionGroupUsersCommandOutput} + * @see {@link ListTrafficDistributionGroupUsersCommandInput} for command's `input` shape. + * @see {@link ListTrafficDistributionGroupUsersCommandOutput} for command's `response` shape. + * @see {@link ConnectClientResolvedConfig | config} for ConnectClient's `config` shape. + * + * @throws {@link AccessDeniedException} (client fault) + *You do not have sufficient permissions to perform this action.
+ * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceNotFoundException} (client fault) + *The specified resource was not found.
+ * + * @throws {@link ThrottlingException} (client fault) + *The throttling limit has been exceeded.
+ * + * @throws {@link ConnectServiceException} + *Base exception class for all service exceptions from Connect service.
+ * + */ +export class ListTrafficDistributionGroupUsersCommand extends $Command< + ListTrafficDistributionGroupUsersCommandInput, + ListTrafficDistributionGroupUsersCommandOutput, + ConnectClientResolvedConfig +> { + // Start section: command_properties + // End section: command_properties + + public static getEndpointParameterInstructions(): EndpointParameterInstructions { + return { + UseFIPS: { type: "builtInParams", name: "useFipsEndpoint" }, + Endpoint: { type: "builtInParams", name: "endpoint" }, + Region: { type: "builtInParams", name: "region" }, + UseDualStack: { type: "builtInParams", name: "useDualstackEndpoint" }, + }; + } + + /** + * @public + */ + constructor(readonly input: ListTrafficDistributionGroupUsersCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackWhether agents with this routing profile - * will have their routing order calculated based on - * time since their last inbound - * contact or longest idle - * time.
+ *Whether agents with this routing profile will have their routing order calculated based on + * time since their last inbound contact or longest idle + * time.
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript diff --git a/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts b/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts index 2daf181b2670..005e71339b05 100644 --- a/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts +++ b/clients/client-connect/src/commands/UpdateTrafficDistributionCommand.ts @@ -37,6 +37,11 @@ export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDis /** * @public *Updates the traffic distribution for a given traffic distribution group.
+ *You can change the SignInConfig only for a default TrafficDistributionGroup. If you call
+ * UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,
+ * an InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony * traffic distribution across Amazon Web Services Regions * in the Amazon Connect Administrator Guide.
@@ -56,6 +61,22 @@ export interface UpdateTrafficDistributionCommandOutput extends UpdateTrafficDis * }, * ], * }, + * SignInConfig: { // SignInConfig + * Distributions: [ // SignInDistributionList // required + * { // SignInDistribution + * Region: "STRING_VALUE", // required + * Enabled: true || false, // required + * }, + * ], + * }, + * AgentConfig: { // AgentConfig + * Distributions: [ // required + * { + * Region: "STRING_VALUE", // required + * Percentage: Number("int"), // required + * }, + * ], + * }, * }; * const command = new UpdateTrafficDistributionCommand(input); * const response = await client.send(command); diff --git a/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts b/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts index 4c0eb217cf96..6e37f60a3680 100644 --- a/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserHierarchyStructureCommand.ts @@ -14,7 +14,7 @@ import { } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; -import { UpdateUserHierarchyStructureRequest } from "../models/models_1"; +import { UpdateUserHierarchyStructureRequest } from "../models/models_2"; import { de_UpdateUserHierarchyStructureCommand, se_UpdateUserHierarchyStructureCommand, diff --git a/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts b/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts index 2b50377e461e..30596bc619f3 100644 --- a/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserIdentityInfoCommand.ts @@ -14,7 +14,7 @@ import { } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; -import { UpdateUserIdentityInfoRequest } from "../models/models_1"; +import { UpdateUserIdentityInfoRequest } from "../models/models_2"; import { de_UpdateUserIdentityInfoCommand, se_UpdateUserIdentityInfoCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts b/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts index b3d6d67d7f51..2e8633475165 100644 --- a/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserPhoneConfigCommand.ts @@ -14,7 +14,7 @@ import { } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; -import { UpdateUserPhoneConfigRequest } from "../models/models_1"; +import { UpdateUserPhoneConfigRequest } from "../models/models_2"; import { de_UpdateUserPhoneConfigCommand, se_UpdateUserPhoneConfigCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts b/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts index 500440a9c717..46aefad527a6 100644 --- a/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserRoutingProfileCommand.ts @@ -14,7 +14,7 @@ import { } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; -import { UpdateUserRoutingProfileRequest } from "../models/models_1"; +import { UpdateUserRoutingProfileRequest } from "../models/models_2"; import { de_UpdateUserRoutingProfileCommand, se_UpdateUserRoutingProfileCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts b/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts index d123fd45026c..13389da67e0c 100644 --- a/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts +++ b/clients/client-connect/src/commands/UpdateUserSecurityProfilesCommand.ts @@ -14,7 +14,7 @@ import { } from "@smithy/types"; import { ConnectClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ConnectClient"; -import { UpdateUserSecurityProfilesRequest } from "../models/models_1"; +import { UpdateUserSecurityProfilesRequest } from "../models/models_2"; import { de_UpdateUserSecurityProfilesCommand, se_UpdateUserSecurityProfilesCommand } from "../protocols/Aws_restJson1"; /** diff --git a/clients/client-connect/src/commands/index.ts b/clients/client-connect/src/commands/index.ts index d0a3214a84ee..1bbdf374f68c 100644 --- a/clients/client-connect/src/commands/index.ts +++ b/clients/client-connect/src/commands/index.ts @@ -10,6 +10,7 @@ export * from "./AssociatePhoneNumberContactFlowCommand"; export * from "./AssociateQueueQuickConnectsCommand"; export * from "./AssociateRoutingProfileQueuesCommand"; export * from "./AssociateSecurityKeyCommand"; +export * from "./AssociateTrafficDistributionGroupUserCommand"; export * from "./ClaimPhoneNumberCommand"; export * from "./CreateAgentStatusCommand"; export * from "./CreateContactFlowCommand"; @@ -82,6 +83,7 @@ export * from "./DisassociatePhoneNumberContactFlowCommand"; export * from "./DisassociateQueueQuickConnectsCommand"; export * from "./DisassociateRoutingProfileQueuesCommand"; export * from "./DisassociateSecurityKeyCommand"; +export * from "./DisassociateTrafficDistributionGroupUserCommand"; export * from "./DismissUserContactCommand"; export * from "./GetContactAttributesCommand"; export * from "./GetCurrentMetricDataCommand"; @@ -123,6 +125,7 @@ export * from "./ListSecurityProfilePermissionsCommand"; export * from "./ListSecurityProfilesCommand"; export * from "./ListTagsForResourceCommand"; export * from "./ListTaskTemplatesCommand"; +export * from "./ListTrafficDistributionGroupUsersCommand"; export * from "./ListTrafficDistributionGroupsCommand"; export * from "./ListUseCasesCommand"; export * from "./ListUserHierarchyGroupsCommand"; diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts index d4bfc2871084..dabd41395121 100644 --- a/clients/client-connect/src/models/models_0.ts +++ b/clients/client-connect/src/models/models_0.ts @@ -236,6 +236,36 @@ export const AgentAvailabilityTimer = { */ export type AgentAvailabilityTimer = (typeof AgentAvailabilityTimer)[keyof typeof AgentAvailabilityTimer]; +/** + * @public + *Information about a traffic distribution.
+ */ +export interface Distribution { + /** + * @public + *The Amazon Web Services Region where the traffic is distributed.
+ */ + Region: string | undefined; + + /** + * @public + *The percentage of the traffic that is distributed, in increments of 10.
+ */ + Percentage: number | undefined; +} + +/** + * @public + *The distribution of agents between the instance and its replica(s).
+ */ +export interface AgentConfig { + /** + * @public + *Information about traffic distributions.
+ */ + Distributions: Distribution[] | undefined; +} + /** * @public * @enum @@ -1146,6 +1176,36 @@ export interface AssociateSecurityKeyResponse { AssociationId?: string; } +/** + * @public + */ +export interface AssociateTrafficDistributionGroupUserRequest { + /** + * @public + *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.
+ */ + TrafficDistributionGroupId: string | undefined; + + /** + * @public + *The identifier of the user account. This can be the ID or the ARN of the user.
+ */ + UserId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface AssociateTrafficDistributionGroupUserResponse {} + /** * @public */ @@ -2829,11 +2889,9 @@ export interface CreateRoutingProfileRequest { /** * @public - *Whether agents with this routing profile - * will have their routing order calculated based on - * time since their last inbound - * contact or longest idle - * time.
+ *Whether agents with this routing profile will have their routing order calculated based on + * longest idle time or time since their last inbound + * contact.
*/ AgentAvailabilityTimer?: AgentAvailabilityTimer | string; } @@ -6287,11 +6345,9 @@ export interface RoutingProfile { /** * @public - *Whether agents with this routing profile - * will have their routing order calculated based on - * time since their last inbound - * contact or longest idle - * time.
+ *Whether agents with this routing profile will have their routing order calculated based on + * time since their last inbound contact or longest idle + * time.
*/ AgentAvailabilityTimer?: AgentAvailabilityTimer | string; } @@ -6598,6 +6654,20 @@ export interface TrafficDistributionGroup { *The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
*/ Tags?: RecordWhether this is the default traffic distribution group created during instance
+ * replication. The default traffic distribution group cannot be deleted by the
+ * DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as
+ * part of the process for deleting a replica.
You can change the SignInConfig only for a default TrafficDistributionGroup. If you call
+ * UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,
+ * an InvalidRequestException is returned.
The identifier of the user account.
+ *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.
*/ - UserId: string | undefined; + TrafficDistributionGroupId: string | undefined; /** * @public - *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the - * instance.
+ *The identifier for the user. This can be the ID or the ARN of the user.
*/ - InstanceId: string | undefined; + UserId: string | undefined; /** * @public - *The identifier of the contact.
+ *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
*/ - ContactId: string | undefined; + InstanceId: string | undefined; } /** * @public */ -export interface DismissUserContactResponse {} +export interface DisassociateTrafficDistributionGroupUserResponse {} /** * @public */ -export interface GetContactAttributesRequest { +export interface DismissUserContactRequest { /** * @public - *The identifier of the Amazon Connect instance.
+ *The identifier of the user account.
*/ - InstanceId: string | undefined; + UserId: string | undefined; /** * @public - *The identifier of the initial contact.
+ *The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the + * instance.
*/ - InitialContactId: string | undefined; -} + InstanceId: string | undefined; -/** - * @public - */ -export interface GetContactAttributesResponse { /** * @public - *Information about the attributes.
+ *The identifier of the contact.
*/ - Attributes?: RecordContains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator - * Guide.
- */ -export interface CurrentMetric { - /** - * @public - *The name of the metric.
- */ - Name?: CurrentMetricName | string; - - /** - * @public - *The unit for the metric.
- */ - Unit?: Unit | string; -} +export interface DismissUserContactResponse {} /** * @public - *Contains the filter to apply when retrieving metrics.
*/ -export interface Filters { - /** - * @public - *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 GetCurrentMetricsData API in particular
- * requires a queue when you include a Filter in your request.
The channel to use to filter the metrics.
+ *The identifier of the Amazon Connect instance.
*/ - Channels?: (Channel | string)[]; + InstanceId: string | undefined; /** * @public - *A list of up to 100 routing profile IDs or ARNs.
+ *The identifier of the initial contact.
*/ - RoutingProfiles?: string[]; + InitialContactId: string | undefined; } -/** - * @public - * @enum - */ -export const Grouping = { - CHANNEL: "CHANNEL", - QUEUE: "QUEUE", - ROUTING_PROFILE: "ROUTING_PROFILE", -} as const; - -/** - * @public - */ -export type Grouping = (typeof Grouping)[keyof typeof Grouping]; - /** * @internal */ diff --git a/clients/client-connect/src/models/models_1.ts b/clients/client-connect/src/models/models_1.ts index d5eaa5104149..1c8709593fab 100644 --- a/clients/client-connect/src/models/models_1.ts +++ b/clients/client-connect/src/models/models_1.ts @@ -5,6 +5,7 @@ import { ConnectServiceException as __BaseException } from "./ConnectServiceExce import { ActionSummary, AgentAvailabilityTimer, + AgentConfig, AgentContactReference, AgentStatusReference, AgentStatusState, @@ -16,19 +17,14 @@ import { ContactFlowState, ContactFlowType, ContactState, - CurrentMetric, - CurrentMetricName, DirectoryType, + Distribution, EvaluationAnswerData, - EvaluationFormQuestion, - EvaluationFormScoringStrategy, EvaluationFormVersionStatus, EvaluationNote, EvaluationScore, EvaluationStatus, EventSourceName, - Filters, - Grouping, HierarchyGroupSummary, HoursOfOperation, HoursOfOperationConfig, @@ -63,14 +59,123 @@ import { TaskTemplateField, TaskTemplateStatus, TrafficDistributionGroupStatus, - Unit, UseCaseType, - UserIdentityInfo, UserPhoneConfig, VocabularyLanguageCode, VocabularyState, } from "./models_0"; +/** + * @public + */ +export interface GetContactAttributesResponse { + /** + * @public + *Information about the attributes.
+ */ + Attributes?: RecordContains information about a real-time metric. For a description of each metric, see Real-time Metrics Definitions in the Amazon Connect Administrator + * Guide.
+ */ +export interface CurrentMetric { + /** + * @public + *The name of the metric.
+ */ + Name?: CurrentMetricName | string; + + /** + * @public + *The unit for the metric.
+ */ + Unit?: Unit | string; +} + +/** + * @public + *Contains the filter to apply when retrieving metrics.
+ */ +export interface Filters { + /** + * @public + *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 GetCurrentMetricsData API in particular
+ * requires a queue when you include a Filter in your request.
The channel to use to filter the metrics.
+ */ + Channels?: (Channel | string)[]; + + /** + * @public + *A list of up to 100 routing profile IDs or ARNs.
+ */ + RoutingProfiles?: string[]; +} + +/** + * @public + * @enum + */ +export const Grouping = { + CHANNEL: "CHANNEL", + QUEUE: "QUEUE", + ROUTING_PROFILE: "ROUTING_PROFILE", +} as const; + +/** + * @public + */ +export type Grouping = (typeof Grouping)[keyof typeof Grouping]; + /** * @public * @enum @@ -725,7 +830,7 @@ export interface GetFederationTokenResponse { /** * @public - *The identifier for the user.
+ *The identifier for the user. This can be the ID or the ARN of the user.
*/ UserId?: string; } @@ -1392,7 +1497,7 @@ export interface GetMetricDataV2Request { *Unit: Seconds
*Valid metric filter key: INITIATION_METHOD. For now, this metric only
* supports the following as INITIATION_METHOD: INBOUND |
- * OUTBOUND | CALLBACK | API
+ * OUTBOUND | CALLBACK | API
*
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
* @@ -1411,7 +1516,8 @@ export interface GetMetricDataV2Request { * *This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Count
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*This metric is available only for contacts analyzed by Contact Lens conversational analytics.
+ *This metric is available only for contacts analyzed by Contact Lens conversational + * analytics.
*Unit: Seconds
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*Information about a traffic distribution.
+ *The distribution of sign in traffic between the instance and its replica(s).
*/ -export interface Distribution { +export interface SignInDistribution { /** * @public - *The Amazon Web Services Region where the traffic is distributed.
+ *The Amazon Web Services Region of the sign in distribution.
*/ Region: string | undefined; /** * @public - *The percentage of the traffic that is distributed, in increments of 10.
+ *Whether sign in distribution is enabled.
+ */ + Enabled: boolean | undefined; +} + +/** + * @public + *The distribution of allowing signing in to the instance and its replica(s).
+ */ +export interface SignInConfig { + /** + * @public + *Information about traffic distributions.
*/ - Percentage: number | undefined; + Distributions: SignInDistribution[] | undefined; } /** @@ -1866,6 +1990,18 @@ export interface GetTrafficDistributionResponse { *The Amazon Resource Name (ARN) of the traffic distribution group.
*/ Arn?: string; + + /** + * @public + *The distribution of allowing signing in to the instance and its replica(s).
+ */ + SignInConfig?: SignInConfig; + + /** + * @public + *The distribution of agents between the instance and its replica(s).
+ */ + AgentConfig?: AgentConfig; } /** @@ -4521,6 +4657,15 @@ export interface TrafficDistributionGroupSummary { * */ Status?: TrafficDistributionGroupStatus | string; + + /** + * @public + *Whether this is the default traffic distribution group created during instance
+ * replication. The default traffic distribution group cannot be deleted by the
+ * DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as
+ * part of the process for deleting a replica.
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.
+ */ + TrafficDistributionGroupId: string | undefined; + + /** + * @public + *The maximum number of results to return per page.
+ */ + MaxResults?: number; + + /** + * @public + *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.
+ */ + NextToken?: string; +} + +/** + * @public + *Summary information about a traffic distribution group user.
+ */ +export interface TrafficDistributionGroupUserSummary { + /** + * @public + *The identifier for the user. This can be the ID or the ARN of the user.
+ */ + UserId?: string; +} + +/** + * @public + */ +export interface ListTrafficDistributionGroupUsersResponse { + /** + * @public + *If there are additional results, this is the token for the next set of results.
+ */ + NextToken?: string; + + /** + * @public + *A list of traffic distribution group users.
+ */ + TrafficDistributionGroupUserSummaryList?: TrafficDistributionGroupUserSummary[]; +} + /** * @public *Provides summary information about the use cases for the specified integration @@ -6739,7 +6939,7 @@ export interface TransferContactRequest { /** * @public - *
The identifier for the user.
+ *The identifier for the user. This can be the ID or the ARN of the user.
*/ UserId?: string; @@ -7778,11 +7978,9 @@ export interface UpdateRoutingProfileAgentAvailabilityTimerRequest { /** * @public - *Whether agents with this routing profile - * will have their routing order calculated based on - * time since their last inbound - * contact or longest idle - * time.
+ *Whether agents with this routing profile will have their routing order calculated based on + * time since their last inbound contact or longest idle + * time.
*/ AgentAvailabilityTimer: AgentAvailabilityTimer | string | undefined; } @@ -8130,6 +8328,18 @@ export interface UpdateTrafficDistributionRequest { *The distribution of traffic between the instance and its replica(s).
*/ TelephonyConfig?: TelephonyConfig; + + /** + * @public + *The distribution of allowing signing in to the instance and its replica(s).
+ */ + SignInConfig?: SignInConfig; + + /** + * @public + *The distribution of agents between the instance and its replica(s).
+ */ + AgentConfig?: AgentConfig; } /** @@ -8195,381 +8405,6 @@ export interface HierarchyLevelUpdate { Name: string | undefined; } -/** - * @public - *Contains information about the level hierarchy to update.
- */ -export interface HierarchyStructureUpdate { - /** - * @public - *The - * update - * for level one.
- */ - LevelOne?: HierarchyLevelUpdate; - - /** - * @public - *The update for level two.
- */ - LevelTwo?: HierarchyLevelUpdate; - - /** - * @public - *The update for level three.
- */ - LevelThree?: HierarchyLevelUpdate; - - /** - * @public - *The update for level four.
- */ - LevelFour?: HierarchyLevelUpdate; - - /** - * @public - *The update for level five.
- */ - LevelFive?: HierarchyLevelUpdate; -} - -/** - * @public - */ -export interface UpdateUserHierarchyStructureRequest { - /** - * @public - *The hierarchy levels to update.
- */ - HierarchyStructure: HierarchyStructureUpdate | undefined; - - /** - * @public - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; -} - -/** - * @public - */ -export interface UpdateUserIdentityInfoRequest { - /** - * @public - *The identity information for the user.
- */ - IdentityInfo: UserIdentityInfo | undefined; - - /** - * @public - *The identifier of the user account.
- */ - UserId: string | undefined; - - /** - * @public - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; -} - -/** - * @public - */ -export interface UpdateUserPhoneConfigRequest { - /** - * @public - *Information about phone configuration settings for the user.
- */ - PhoneConfig: UserPhoneConfig | undefined; - - /** - * @public - *The identifier of the user account.
- */ - UserId: string | undefined; - - /** - * @public - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; -} - -/** - * @public - */ -export interface UpdateUserRoutingProfileRequest { - /** - * @public - *The identifier of the routing profile for the user.
- */ - RoutingProfileId: string | undefined; - - /** - * @public - *The identifier of the user account.
- */ - UserId: string | undefined; - - /** - * @public - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; -} - -/** - * @public - */ -export interface UpdateUserSecurityProfilesRequest { - /** - * @public - *The identifiers of the security profiles for the user.
- */ - SecurityProfileIds: string[] | undefined; - - /** - * @public - *The identifier of the user account.
- */ - UserId: string | undefined; - - /** - * @public - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; -} - -/** - * @public - *Information about an item from an evaluation form. The item must be either a section or a - * question.
- */ -export type EvaluationFormItem = - | EvaluationFormItem.QuestionMember - | EvaluationFormItem.SectionMember - | EvaluationFormItem.$UnknownMember; - -/** - * @public - */ -export namespace EvaluationFormItem { - /** - * @public - *The information of the section.
- */ - export interface SectionMember { - Section: EvaluationFormSection; - Question?: never; - $unknown?: never; - } - - /** - * @public - *The information of the question.
- */ - export interface QuestionMember { - Section?: never; - Question: EvaluationFormQuestion; - $unknown?: never; - } - - /** - * @public - */ - export interface $UnknownMember { - Section?: never; - Question?: never; - $unknown: [string, any]; - } - - export interface VisitorInformation about a section from an evaluation form. A section can contain sections and/or - * questions. Evaluation forms can only contain sections and subsections (two level nesting).
- */ -export interface EvaluationFormSection { - /** - * @public - *The title of the section.
- */ - Title: string | undefined; - - /** - * @public - *The identifier of the section. An identifier must be unique within the evaluation - * form.
- */ - RefId: string | undefined; - - /** - * @public - *The instructions of the section.
- */ - Instructions?: string; - - /** - * @public - *The items of the section.
- */ - Items: EvaluationFormItem[] | undefined; - - /** - * @public - *The scoring weight of the section.
- */ - Weight?: number; -} - -/** - * @public - */ -export interface CreateEvaluationFormRequest { - /** - * @public - *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
- */ - InstanceId: string | undefined; - - /** - * @public - *A title of the evaluation form.
- */ - Title: string | undefined; - - /** - * @public - *The description of the evaluation form.
- */ - Description?: string; - - /** - * @public - *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.
- */ - Items: EvaluationFormItem[] | undefined; - - /** - * @public - *A scoring strategy of the evaluation form.
- */ - ScoringStrategy?: EvaluationFormScoringStrategy; - - /** - * @public - *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 - * Making retries safe with idempotent APIs.
- */ - ClientToken?: string; -} - -/** - * @public - *Information about the evaluation form.
- */ -export interface EvaluationForm { - /** - * @public - *The unique identifier for the evaluation form.
- */ - EvaluationFormId: string | undefined; - - /** - * @public - *A version of the evaluation form.
- */ - EvaluationFormVersion: number | undefined; - - /** - * @public - *The flag indicating whether the evaluation form is locked for changes.
- */ - Locked: boolean | undefined; - - /** - * @public - *The Amazon Resource Name (ARN) for the evaluation form resource.
- */ - EvaluationFormArn: string | undefined; - - /** - * @public - *A title of the evaluation form.
- */ - Title: string | undefined; - - /** - * @public - *The description of the evaluation form.
- */ - Description?: string; - - /** - * @public - *The status of the evaluation form.
- */ - Status: EvaluationFormVersionStatus | string | undefined; - - /** - * @public - *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.
- */ - Items: EvaluationFormItem[] | undefined; - - /** - * @public - *A scoring strategy of the evaluation form.
- */ - ScoringStrategy?: EvaluationFormScoringStrategy; - - /** - * @public - *The timestamp for when the evaluation form was created.
- */ - CreatedTime: Date | undefined; - - /** - * @public - *The Amazon Resource Name (ARN) of the user who created the evaluation form.
- */ - CreatedBy: string | undefined; - - /** - * @public - *The timestamp for when the evaluation form was last updated.
- */ - LastModifiedTime: Date | undefined; - - /** - * @public - *The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
- */ - LastModifiedBy: string | undefined; - - /** - * @public - *The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
- */ - Tags?: RecordContains information about the level hierarchy to update.
+ */ +export interface HierarchyStructureUpdate { + /** + * @public + *The + * update + * for level one.
+ */ + LevelOne?: HierarchyLevelUpdate; + + /** + * @public + *The update for level two.
+ */ + LevelTwo?: HierarchyLevelUpdate; + + /** + * @public + *The update for level three.
+ */ + LevelThree?: HierarchyLevelUpdate; + + /** + * @public + *The update for level four.
+ */ + LevelFour?: HierarchyLevelUpdate; + + /** + * @public + *The update for level five.
+ */ + LevelFive?: HierarchyLevelUpdate; +} + +/** + * @public + */ +export interface UpdateUserHierarchyStructureRequest { + /** + * @public + *The hierarchy levels to update.
+ */ + HierarchyStructure: HierarchyStructureUpdate | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserIdentityInfoRequest { + /** + * @public + *The identity information for the user.
+ */ + IdentityInfo: UserIdentityInfo | undefined; + + /** + * @public + *The identifier of the user account.
+ */ + UserId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserPhoneConfigRequest { + /** + * @public + *Information about phone configuration settings for the user.
+ */ + PhoneConfig: UserPhoneConfig | undefined; + + /** + * @public + *The identifier of the user account.
+ */ + UserId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserRoutingProfileRequest { + /** + * @public + *The identifier of the routing profile for the user.
+ */ + RoutingProfileId: string | undefined; + + /** + * @public + *The identifier of the user account.
+ */ + UserId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; +} + +/** + * @public + */ +export interface UpdateUserSecurityProfilesRequest { + /** + * @public + *The identifiers of the security profiles for the user.
+ */ + SecurityProfileIds: string[] | undefined; + + /** + * @public + *The identifier of the user account.
+ */ + UserId: string | undefined; + + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; +} + +/** + * @public + *Information about an item from an evaluation form. The item must be either a section or a + * question.
+ */ +export type EvaluationFormItem = + | EvaluationFormItem.QuestionMember + | EvaluationFormItem.SectionMember + | EvaluationFormItem.$UnknownMember; + +/** + * @public + */ +export namespace EvaluationFormItem { + /** + * @public + *The information of the section.
+ */ + export interface SectionMember { + Section: EvaluationFormSection; + Question?: never; + $unknown?: never; + } + + /** + * @public + *The information of the question.
+ */ + export interface QuestionMember { + Section?: never; + Question: EvaluationFormQuestion; + $unknown?: never; + } + + /** + * @public + */ + export interface $UnknownMember { + Section?: never; + Question?: never; + $unknown: [string, any]; + } + + export interface VisitorInformation about a section from an evaluation form. A section can contain sections and/or + * questions. Evaluation forms can only contain sections and subsections (two level nesting).
+ */ +export interface EvaluationFormSection { + /** + * @public + *The title of the section.
+ */ + Title: string | undefined; + + /** + * @public + *The identifier of the section. An identifier must be unique within the evaluation + * form.
+ */ + RefId: string | undefined; + + /** + * @public + *The instructions of the section.
+ */ + Instructions?: string; + + /** + * @public + *The items of the section.
+ */ + Items: EvaluationFormItem[] | undefined; + + /** + * @public + *The scoring weight of the section.
+ */ + Weight?: number; +} + +/** + * @public + */ +export interface CreateEvaluationFormRequest { + /** + * @public + *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ */ + InstanceId: string | undefined; + + /** + * @public + *A title of the evaluation form.
+ */ + Title: string | undefined; + + /** + * @public + *The description of the evaluation form.
+ */ + Description?: string; + + /** + * @public + *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.
+ */ + Items: EvaluationFormItem[] | undefined; + + /** + * @public + *A scoring strategy of the evaluation form.
+ */ + ScoringStrategy?: EvaluationFormScoringStrategy; + + /** + * @public + *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 + * Making retries safe with idempotent APIs.
+ */ + ClientToken?: string; +} + +/** + * @public + *Information about the evaluation form.
+ */ +export interface EvaluationForm { + /** + * @public + *The unique identifier for the evaluation form.
+ */ + EvaluationFormId: string | undefined; + + /** + * @public + *A version of the evaluation form.
+ */ + EvaluationFormVersion: number | undefined; + + /** + * @public + *The flag indicating whether the evaluation form is locked for changes.
+ */ + Locked: boolean | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) for the evaluation form resource.
+ */ + EvaluationFormArn: string | undefined; + + /** + * @public + *A title of the evaluation form.
+ */ + Title: string | undefined; + + /** + * @public + *The description of the evaluation form.
+ */ + Description?: string; + + /** + * @public + *The status of the evaluation form.
+ */ + Status: EvaluationFormVersionStatus | string | undefined; + + /** + * @public + *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.
+ */ + Items: EvaluationFormItem[] | undefined; + + /** + * @public + *A scoring strategy of the evaluation form.
+ */ + ScoringStrategy?: EvaluationFormScoringStrategy; + + /** + * @public + *The timestamp for when the evaluation form was created.
+ */ + CreatedTime: Date | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the user who created the evaluation form.
+ */ + CreatedBy: string | undefined; + + /** + * @public + *The timestamp for when the evaluation form was last updated.
+ */ + LastModifiedTime: Date | undefined; + + /** + * @public + *The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
+ */ + LastModifiedBy: string | undefined; + + /** + * @public + *The tags used to organize, track, or control access for this resource. For example, \{ "tags": \{"key1":"value1", "key2":"value2"\} \}.
+ */ + Tags?: RecordInformation about an evaluation form used in a contact evaluation.
diff --git a/clients/client-connect/src/pagination/ListTrafficDistributionGroupUsersPaginator.ts b/clients/client-connect/src/pagination/ListTrafficDistributionGroupUsersPaginator.ts new file mode 100644 index 000000000000..cf38440329b4 --- /dev/null +++ b/clients/client-connect/src/pagination/ListTrafficDistributionGroupUsersPaginator.ts @@ -0,0 +1,50 @@ +// smithy-typescript generated code +import { Paginator } from "@smithy/types"; + +import { + ListTrafficDistributionGroupUsersCommand, + ListTrafficDistributionGroupUsersCommandInput, + ListTrafficDistributionGroupUsersCommandOutput, +} from "../commands/ListTrafficDistributionGroupUsersCommand"; +import { ConnectClient } from "../ConnectClient"; +import { ConnectPaginationConfiguration } from "./Interfaces"; + +/** + * @internal + */ +const makePagedClientRequest = async ( + client: ConnectClient, + input: ListTrafficDistributionGroupUsersCommandInput, + ...args: any +): PromiseInformation about traffic distributions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution of agents between the instance and its replica(s).
" + } + }, "com.amazonaws.connect#AgentContactReference": { "type": "structure", "members": { @@ -615,6 +630,9 @@ { "target": "com.amazonaws.connect#AssociateSecurityKey" }, + { + "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUser" + }, { "target": "com.amazonaws.connect#ClaimPhoneNumber" }, @@ -831,6 +849,9 @@ { "target": "com.amazonaws.connect#DisassociateSecurityKey" }, + { + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUser" + }, { "target": "com.amazonaws.connect#DismissUserContact" }, @@ -957,6 +978,9 @@ { "target": "com.amazonaws.connect#ListTrafficDistributionGroups" }, + { + "target": "com.amazonaws.connect#ListTrafficDistributionGroupUsers" + }, { "target": "com.amazonaws.connect#ListUseCases" }, @@ -2698,6 +2722,81 @@ "smithy.api#output": {} } }, + "com.amazonaws.connect#AssociateTrafficDistributionGroupUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#AssociateTrafficDistributionGroupUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Associates an agent with a traffic distribution group.
", + "smithy.api#http": { + "method": "PUT", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#AssociateTrafficDistributionGroupUserRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "The identifier of the user account. This can be the ID or the ARN of the user.
", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#AssociateTrafficDistributionGroupUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#AssociationId": { "type": "string", "traits": { @@ -5200,7 +5299,7 @@ "AgentAvailabilityTimer": { "target": "com.amazonaws.connect#AgentAvailabilityTimer", "traits": { - "smithy.api#documentation": "Whether agents with this routing profile\n will have their routing order calculated based on\n time since their last inbound\n contact or longest idle\n time.
" + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n longest idle time or time since their last inbound\n contact.
" } } }, @@ -5687,7 +5786,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupId", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -7429,7 +7528,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -8985,7 +9084,7 @@ "TrafficDistributionGroupId": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -9964,6 +10063,83 @@ "smithy.api#input": {} } }, + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUser": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserRequest" + }, + "output": { + "target": "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceConflictException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Disassociates an agent from a traffic distribution group.
", + "smithy.api#http": { + "method": "DELETE", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", + "code": 200 + }, + "smithy.api#idempotent": {} + } + }, + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "UserId": { + "target": "com.amazonaws.connect#UserId", + "traits": { + "smithy.api#documentation": "The identifier for the user. This can be the ID or the ARN of the user.
", + "smithy.api#httpQuery": "UserId", + "smithy.api#required": {} + } + }, + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
", + "smithy.api#httpQuery": "InstanceId", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#DisassociateTrafficDistributionGroupUserResponse": { + "type": "structure", + "members": {}, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#DismissUserContact": { "type": "operation", "input": { @@ -11961,7 +12137,7 @@ "UserId": { "target": "com.amazonaws.connect#AgentResourceId", "traits": { - "smithy.api#documentation": "The identifier for the user.
" + "smithy.api#documentation": "The identifier for the user. This can be the ID or the ARN of the user.
" } } }, @@ -12170,7 +12346,7 @@ "Metrics": { "target": "com.amazonaws.connect#MetricsV2", "traits": { - "smithy.api#documentation": "The metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe metrics to retrieve. Specify the name, groupings, and filters for each metric. The\n following historical metrics are available. For a description of each metric, see Historical metrics definitions in the Amazon Connect Administrator's\n Guide.
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Percentage
\nValid groupings and filters: Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only in Amazon Web Services Regions where Forecasting, capacity planning, and scheduling is available.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid metric filter key: INITIATION_METHOD. For now, this metric only\n supports the following as INITIATION_METHOD: INBOUND |\n OUTBOUND | CALLBACK | API\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nThis metric is available only for contacts analyzed by Contact Lens conversational\n analytics.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD\n
Valid groupings and filters: Queue, Channel, Routing Profile, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid metric filter key: INITIATION_METHOD,\n DISCONNECT_REASON\n
Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy, Feature
\nFeature is a valid filter but not a valid grouping.
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
\nYou can include up to 20 SERVICE_LEVEL metrics in a request.
\nUnit: Percent
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThreshold: For ThresholdValue, enter any whole number from 1 to 604800\n (inclusive), in seconds. For Comparison, you must enter LT (for\n \"Less than\").
Valid metric filter key: DISCONNECT_REASON\n
Unit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nUnit: Count
\nValid groupings and filters: Queue, Channel, Routing Profile
\nThe identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -12508,6 +12684,18 @@ "traits": { "smithy.api#documentation": "The Amazon Resource Name (ARN) of the traffic distribution group.
" } + }, + "SignInConfig": { + "target": "com.amazonaws.connect#SignInConfig", + "traits": { + "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + } + }, + "AgentConfig": { + "target": "com.amazonaws.connect#AgentConfig", + "traits": { + "smithy.api#documentation": "The distribution of agents between the instance and its replica(s).
" + } } }, "traits": { @@ -16021,7 +16209,7 @@ } ], "traits": { - "smithy.api#documentation": "Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided\n TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions\n associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.
", + "smithy.api#documentation": "Lists phone numbers claimed to your Amazon Connect instance or traffic distribution group. If the provided\n TargetArn is a traffic distribution group, you can call this API in both Amazon Web Services Regions\n associated with traffic distribution group.
For more information about phone numbers, see Set Up Phone Numbers for Your\n Contact Center in the Amazon Connect Administrator\n Guide.
\nWhen given an instance ARN, ListPhoneNumbersV2 returns only the phone\n numbers claimed to the instance.
When given a traffic distribution group ARN ListPhoneNumbersV2 returns only the phone numbers\n claimed to the traffic distribution group.
Lists traffic distribution group users.
", + "smithy.api#http": { + "method": "GET", + "uri": "/traffic-distribution-group/{TrafficDistributionGroupId}/user", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "TrafficDistributionGroupUserSummaryList", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroupUsersRequest": { + "type": "structure", + "members": { + "TrafficDistributionGroupId": { + "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", + "traits": { + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult10", + "traits": { + "smithy.api#default": null, + "smithy.api#documentation": "The maximum number of results to return per page.
", + "smithy.api#httpQuery": "maxResults" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "The token for the next set of results. Use the value returned in the previous \nresponse in the next request to retrieve the next set of results.
", + "smithy.api#httpQuery": "nextToken" + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, + "com.amazonaws.connect#ListTrafficDistributionGroupUsersResponse": { + "type": "structure", + "members": { + "NextToken": { + "target": "com.amazonaws.connect#NextToken", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "TrafficDistributionGroupUserSummaryList": { + "target": "com.amazonaws.connect#TrafficDistributionGroupUserSummaryList", + "traits": { + "smithy.api#documentation": "A list of traffic distribution group users.
" + } + } + }, + "traits": { + "smithy.api#output": {} + } + }, "com.amazonaws.connect#ListTrafficDistributionGroups": { "type": "operation", "input": { @@ -21708,7 +21987,7 @@ "AgentAvailabilityTimer": { "target": "com.amazonaws.connect#AgentAvailabilityTimer", "traits": { - "smithy.api#documentation": "Whether agents with this routing profile\n will have their routing order calculated based on\n time since their last inbound\n contact or longest idle\n time.
" + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n time since their last inbound contact or longest idle\n time.
" } } }, @@ -23662,6 +23941,50 @@ "smithy.api#httpError": 402 } }, + "com.amazonaws.connect#SignInConfig": { + "type": "structure", + "members": { + "Distributions": { + "target": "com.amazonaws.connect#SignInDistributionList", + "traits": { + "smithy.api#documentation": "Information about traffic distributions.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + } + }, + "com.amazonaws.connect#SignInDistribution": { + "type": "structure", + "members": { + "Region": { + "target": "com.amazonaws.connect#AwsRegion", + "traits": { + "smithy.api#documentation": "The Amazon Web Services Region of the sign in distribution.
", + "smithy.api#required": {} + } + }, + "Enabled": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether sign in distribution is enabled.
", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "The distribution of sign in traffic between the instance and its replica(s).
" + } + }, + "com.amazonaws.connect#SignInDistributionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#SignInDistribution" + } + }, "com.amazonaws.connect#SingleSelectOptions": { "type": "list", "member": { @@ -25673,7 +25996,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupId", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -25711,6 +26034,13 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } + }, + "IsDefault": { + "target": "com.amazonaws.connect#Boolean", + "traits": { + "smithy.api#default": false, + "smithy.api#documentation": "Whether this is the default traffic distribution group created during instance\n replication. The default traffic distribution group cannot be deleted by the\n DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as\n part of the process for deleting a replica.
You can change the SignInConfig only for a default TrafficDistributionGroup. If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
" + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
" } }, "Arn": { @@ -25808,6 +26138,13 @@ "traits": { "smithy.api#documentation": "The status of the traffic distribution group.
\n\n CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup operation is still in progress and has not yet\n completed.
\n ACTIVE means the previous CreateTrafficDistributionGroup operation has succeeded.
\n CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup operation has failed.
\n PENDING_DELETION means the previous DeleteTrafficDistributionGroup operation is still in progress and has not yet\n completed.
\n DELETION_FAILED means the previous DeleteTrafficDistributionGroup operation has failed.
\n UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet\n completed.
Whether this is the default traffic distribution group created during instance\n replication. The default traffic distribution group cannot be deleted by the\n DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as\n part of the process for deleting a replica.
The identifier for the user. This can be the ID or the ARN of the user.
" + } + } + }, + "traits": { + "smithy.api#documentation": "Summary information about a traffic distribution group user.
" + } + }, + "com.amazonaws.connect#TrafficDistributionGroupUserSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#TrafficDistributionGroupUserSummary" + }, + "traits": { + "smithy.api#length": { + "min": 0, + "max": 10 + } + } + }, "com.amazonaws.connect#TrafficType": { "type": "enum", "members": { @@ -25909,7 +26272,7 @@ "UserId": { "target": "com.amazonaws.connect#AgentResourceId", "traits": { - "smithy.api#documentation": "The identifier for the user.
" + "smithy.api#documentation": "The identifier for the user. This can be the ID or the ARN of the user.
" } }, "ContactFlowId": { @@ -28011,7 +28374,7 @@ } ], "traits": { - "smithy.api#documentation": "Whether agents with this routing profile\n will have their routing order calculated based on\n time since their last inbound\n contact or longest idle\n time.
", + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n time since their last inbound contact or longest idle\n time.
", "smithy.api#http": { "method": "POST", "uri": "/routing-profiles/{InstanceId}/{RoutingProfileId}/agent-availability-timer", @@ -28041,7 +28404,7 @@ "AgentAvailabilityTimer": { "target": "com.amazonaws.connect#AgentAvailabilityTimer", "traits": { - "smithy.api#documentation": "Whether agents with this routing profile\n will have their routing order calculated based on\n time since their last inbound\n contact or longest idle\n time.
", + "smithy.api#documentation": "Whether agents with this routing profile will have their routing order calculated based on\n time since their last inbound contact or longest idle\n time.
", "smithy.api#required": {} } } @@ -28701,7 +29064,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the traffic distribution for a given traffic distribution group.
\nFor more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Updates the traffic distribution for a given traffic distribution group.
\nYou can change the SignInConfig only for a default TrafficDistributionGroup. If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
For more information about updating a traffic distribution group, see Update telephony\n traffic distribution across Amazon Web Services Regions\n in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution/{Id}", @@ -28715,7 +29078,7 @@ "Id": { "target": "com.amazonaws.connect#TrafficDistributionGroupIdOrArn", "traits": { - "smithy.api#documentation": "The identifier of the traffic distribution group. \nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created. \nThe ARN must be provided if the call is from the replicated Region.
", + "smithy.api#documentation": "The identifier of the traffic distribution group.\nThis can be the ID or the ARN if the API is being called in the Region where the traffic distribution group was created.\nThe ARN must be provided if the call is from the replicated Region.
", "smithy.api#httpLabel": {}, "smithy.api#required": {} } @@ -28725,6 +29088,18 @@ "traits": { "smithy.api#documentation": "The distribution of traffic between the instance and its replica(s).
" } + }, + "SignInConfig": { + "target": "com.amazonaws.connect#SignInConfig", + "traits": { + "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + } + }, + "AgentConfig": { + "target": "com.amazonaws.connect#AgentConfig", + "traits": { + "smithy.api#documentation": "The distribution of agents between the instance and its replica(s).
" + } } }, "traits": {