There are limits to the number of Amazon Connect resources that you can create. There -are also limits to the number of requests that you can make per second. For more information, see -Amazon Connect Service Quotas in the Amazon Connect Administrator -Guide.
+are also limits to the number of requests that you can make per second. For more information, +seeP98941055 Amazon Connect Service +Quotas in the Amazon Connect Administrator Guide.You can connect programmatically to an Amazon Web Services service by using an endpoint. For a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
@@ -1684,6 +1684,14 @@ UpdatePhoneNumber [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/classes/updatephonenumbercommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/interfaces/updatephonenumbercommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-connect/interfaces/updatephonenumbercommandoutput.html) + +There are limits to the number of Amazon Connect resources that you can create. There - * are also limits to the number of requests that you can make per second. For more information, see - * Amazon Connect Service Quotas in the Amazon Connect Administrator - * Guide.
+ * are also limits to the number of requests that you can make per second. For more information, + * seeP98941055 Amazon Connect Service + * Quotas in the Amazon Connect Administrator Guide. *You can connect programmatically to an Amazon Web Services service by using an endpoint. For * a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
*/ diff --git a/clients/client-connect/src/ConnectClient.ts b/clients/client-connect/src/ConnectClient.ts index 919d9a813762..5eda512612f3 100644 --- a/clients/client-connect/src/ConnectClient.ts +++ b/clients/client-connect/src/ConnectClient.ts @@ -543,6 +543,10 @@ import { UpdateParticipantRoleConfigCommandOutput, } from "./commands/UpdateParticipantRoleConfigCommand"; import { UpdatePhoneNumberCommandInput, UpdatePhoneNumberCommandOutput } from "./commands/UpdatePhoneNumberCommand"; +import { + UpdatePhoneNumberMetadataCommandInput, + UpdatePhoneNumberMetadataCommandOutput, +} from "./commands/UpdatePhoneNumberMetadataCommand"; import { UpdatePromptCommandInput, UpdatePromptCommandOutput } from "./commands/UpdatePromptCommand"; import { UpdateQueueHoursOfOperationCommandInput, @@ -825,6 +829,7 @@ export type ServiceInputTypes = | UpdateInstanceStorageConfigCommandInput | UpdateParticipantRoleConfigCommandInput | UpdatePhoneNumberCommandInput + | UpdatePhoneNumberMetadataCommandInput | UpdatePromptCommandInput | UpdateQueueHoursOfOperationCommandInput | UpdateQueueMaxContactsCommandInput @@ -1040,6 +1045,7 @@ export type ServiceOutputTypes = | UpdateInstanceStorageConfigCommandOutput | UpdateParticipantRoleConfigCommandOutput | UpdatePhoneNumberCommandOutput + | UpdatePhoneNumberMetadataCommandOutput | UpdatePromptCommandOutput | UpdateQueueHoursOfOperationCommandOutput | UpdateQueueMaxContactsCommandOutput @@ -1245,9 +1251,9 @@ export interface ConnectClientResolvedConfig extends ConnectClientResolvedConfig * contact routing. You can also resolve customer issues more efficiently by getting customers in * touch with the appropriate agents. *There are limits to the number of Amazon Connect resources that you can create. There - * are also limits to the number of requests that you can make per second. For more information, see - * Amazon Connect Service Quotas in the Amazon Connect Administrator - * Guide.
+ * are also limits to the number of requests that you can make per second. For more information, + * seeP98941055 Amazon Connect Service + * Quotas in the Amazon Connect Administrator Guide. *You can connect programmatically to an Amazon Web Services service by using an endpoint. For * a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
*/ diff --git a/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts b/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts index ff403763caf7..8966e38f049f 100644 --- a/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts +++ b/clients/client-connect/src/commands/CreateTrafficDistributionGroupCommand.ts @@ -44,7 +44,7 @@ export interface CreateTrafficDistributionGroupCommandOutput * @public *Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
*You can change the SignInConfig distribution only for a
+ *
The SignInConfig distribution is available only on a
* default TrafficDistributionGroup (see the IsDefault parameter in the
* TrafficDistributionGroup
* data type). If you call
diff --git a/clients/client-connect/src/commands/CreateUserCommand.ts b/clients/client-connect/src/commands/CreateUserCommand.ts
index f098e192c04c..d796b8175554 100644
--- a/clients/client-connect/src/commands/CreateUserCommand.ts
+++ b/clients/client-connect/src/commands/CreateUserCommand.ts
@@ -38,6 +38,12 @@ export interface CreateUserCommandOutput extends CreateUserResponse, __MetadataB
/**
* @public
*
Creates a user account for the specified Amazon Connect instance.
+ *Certain UserIdentityInfo parameters
+ * are required in some situations. For example, Email is required if you are using
+ * SAML for identity management. FirstName and LastName are required if
+ * you are using Amazon Connect or SAML for identity management.
For information about how to create user accounts using the Amazon Connect console, see * Add * Users in the Amazon Connect Administrator Guide.
diff --git a/clients/client-connect/src/commands/GetFederationTokenCommand.ts b/clients/client-connect/src/commands/GetFederationTokenCommand.ts index 386ffea89b1e..973f70092fc3 100644 --- a/clients/client-connect/src/commands/GetFederationTokenCommand.ts +++ b/clients/client-connect/src/commands/GetFederationTokenCommand.ts @@ -41,7 +41,13 @@ export interface GetFederationTokenCommandOutput extends GetFederationTokenRespo /** * @public - *Retrieves a token for federation.
+ *Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is + * for the Amazon Connect user which corresponds to the IAM credentials that were + * used to invoke this action.
+ *For more information about how SAML sign-in works in Amazon Connect, see Configure SAML with + * IAM for Amazon Connect in the Amazon Connect Administrator + * Guide. + *
*This API doesn't support root users. If you try to invoke GetFederationToken with root * credentials, an error message similar to the following one appears:
diff --git a/clients/client-connect/src/commands/GetMetricDataCommand.ts b/clients/client-connect/src/commands/GetMetricDataCommand.ts index 0f787197d3ca..0af5de6c6218 100644 --- a/clients/client-connect/src/commands/GetMetricDataCommand.ts +++ b/clients/client-connect/src/commands/GetMetricDataCommand.ts @@ -40,6 +40,15 @@ export interface GetMetricDataCommandOutput extends GetMetricDataResponse, __Met *Gets historical metric data from the specified Amazon Connect instance.
*For a description of each historical metric, see Historical Metrics * Definitions in the Amazon Connect Administrator Guide.
+ *We recommend using the GetMetricDataV2 API. It
+ * provides more flexibility, features, and the ability to query longer time ranges than
+ * GetMetricData. Use it to retrieve historical agent and contact metrics for the
+ * last 3 months, at varying intervals. You can also use it to build custom dashboards to measure
+ * historical queue and agent performance. For example, you can track the number of incoming
+ * contacts for the last 7 days, with data split by day, to see how contact volume changed per day
+ * of the week.
Searches users in an Amazon Connect instance, with optional filtering.
+ *Searches users in an Amazon Connect instance, with optional filtering.
*
* AfterContactWorkTimeLimit is returned in milliseconds.
Initiates a flow to start a new task.
+ *Initiates a flow to start a new task contact. For more information about task contacts, see + * Concepts: Tasks in + * Amazon Connect in the Amazon Connect Administrator Guide.
+ *When using PreviousContactId and RelatedContactId input
+ * parameters, note the following:
+ * PreviousContactId
+ *
Any updates to user-defined task contact attributes on any contact linked through the
+ * same PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts
+ * can be created that share the same PreviousContactId.
+ * RelatedContactId
+ *
Copies contact attributes from the related task contact to the new contact.
+ *Any update on attributes in a new task contact does not update attributes on previous + * contact.
+ *There’s no limit on the number of task contacts that can be created that use the same
+ * RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters:
+ * ContactFlowID, QuickConnectID, or TaskTemplateID. Only
+ * one parameter is required as long as the task template has a flow configured to run it. If more
+ * than one parameter is specified, or only the TaskTemplateID is specified but it does
+ * not have a flow configured, the request returns an error because Amazon Connect cannot
+ * identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds
+ * the active tasks quota or there are already 12 tasks referencing the same
+ * PreviousContactId. For more information about service quotas for task contacts, see
+ * Amazon Connect service quotas in the Amazon Connect Administrator
+ * Guide.
Updates a phone number’s metadata.
+ *To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
+ *You do not have sufficient permissions to perform this action.
+ * + * @throws {@link IdempotencyException} (client fault) + *An entity with the same name already exists.
+ * + * @throws {@link InternalServiceException} (server fault) + *Request processing failed because of an error or failure with the service.
+ * + * @throws {@link InvalidParameterException} (client fault) + *One or more of the specified parameters are not valid.
+ * + * @throws {@link InvalidRequestException} (client fault) + *The request is not valid.
+ * + * @throws {@link ResourceInUseException} (client fault) + *That resource is already in use. Please try another.
+ * + * @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 UpdatePhoneNumberMetadataCommand extends $Command< + UpdatePhoneNumberMetadataCommandInput, + UpdatePhoneNumberMetadataCommandOutput, + 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: UpdatePhoneNumberMetadataCommandInput) { + // Start section: command_constructor + super(); + // End section: command_constructor + } + + /** + * @internal + */ + resolveMiddleware( + clientStack: MiddlewareStackUpdates the traffic distribution for a given traffic distribution group.
*You can change the SignInConfig distribution only for a
+ *
The SignInConfig distribution is available only on a
* default TrafficDistributionGroup (see the IsDefault parameter in the
* TrafficDistributionGroup
* data type). If you call
diff --git a/clients/client-connect/src/commands/index.ts b/clients/client-connect/src/commands/index.ts
index 72c0142e1983..8146c5447c3a 100644
--- a/clients/client-connect/src/commands/index.ts
+++ b/clients/client-connect/src/commands/index.ts
@@ -183,6 +183,7 @@ export * from "./UpdateInstanceAttributeCommand";
export * from "./UpdateInstanceStorageConfigCommand";
export * from "./UpdateParticipantRoleConfigCommand";
export * from "./UpdatePhoneNumberCommand";
+export * from "./UpdatePhoneNumberMetadataCommand";
export * from "./UpdatePromptCommand";
export * from "./UpdateQueueHoursOfOperationCommand";
export * from "./UpdateQueueMaxContactsCommand";
diff --git a/clients/client-connect/src/endpoint/ruleset.ts b/clients/client-connect/src/endpoint/ruleset.ts
index 066c8e905dae..aaa9e72d2422 100644
--- a/clients/client-connect/src/endpoint/ruleset.ts
+++ b/clients/client-connect/src/endpoint/ruleset.ts
@@ -6,27 +6,29 @@ import { RuleSetObject } from "@smithy/types";
or see "smithy.rules#endpointRuleSet"
in codegen/sdk-codegen/aws-models/connect.json */
-const s="required",
-t="fn",
-u="argv",
-v="ref";
-const a="isSet",
-b="tree",
-c="error",
-d="endpoint",
-e="PartitionResult",
-f="getAttr",
-g={[s]:false,"type":"String"},
-h={[s]:true,"default":false,"type":"Boolean"},
-i={[v]:"Endpoint"},
-j={[t]:"booleanEquals",[u]:[{[v]:"UseFIPS"},true]},
-k={[t]:"booleanEquals",[u]:[{[v]:"UseDualStack"},true]},
-l={},
-m={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[{[v]:e},"supportsFIPS"]}]},
-n={[v]:e},
-o={[t]:"booleanEquals",[u]:[true,{[t]:f,[u]:[n,"supportsDualStack"]}]},
-p=[j],
-q=[k],
-r=[{[v]:"Region"}];
-const _data={version:"1.0",parameters:{Region:g,UseDualStack:h,UseFIPS:h,Endpoint:g},rules:[{conditions:[{[t]:a,[u]:[i]}],type:b,rules:[{conditions:p,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:c},{conditions:q,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:c},{endpoint:{url:i,properties:l,headers:l},type:d}]},{conditions:[{[t]:a,[u]:r}],type:b,rules:[{conditions:[{[t]:"aws.partition",[u]:r,assign:e}],type:b,rules:[{conditions:[j,k],type:b,rules:[{conditions:[m,o],type:b,rules:[{endpoint:{url:"https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:c}]},{conditions:p,type:b,rules:[{conditions:[m],type:b,rules:[{conditions:[{[t]:"stringEquals",[u]:["aws-us-gov",{[t]:f,[u]:[n,"name"]}]}],endpoint:{url:"https://connect.{Region}.amazonaws.com",properties:l,headers:l},type:d},{endpoint:{url:"https://connect-fips.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]},{error:"FIPS is enabled but this partition does not support FIPS",type:c}]},{conditions:q,type:b,rules:[{conditions:[o],type:b,rules:[{endpoint:{url:"https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:l,headers:l},type:d}]},{error:"DualStack is enabled but this partition does not support DualStack",type:c}]},{endpoint:{url:"https://connect.{Region}.{PartitionResult#dnsSuffix}",properties:l,headers:l},type:d}]}]},{error:"Invalid Configuration: Missing Region",type:c}]};
+const u="required",
+v="fn",
+w="argv",
+x="ref";
+const a=true,
+b="isSet",
+c="booleanEquals",
+d="error",
+e="endpoint",
+f="tree",
+g="PartitionResult",
+h="getAttr",
+i={[u]:false,"type":"String"},
+j={[u]:true,"default":false,"type":"Boolean"},
+k={[x]:"Endpoint"},
+l={[v]:c,[w]:[{[x]:"UseFIPS"},true]},
+m={[v]:c,[w]:[{[x]:"UseDualStack"},true]},
+n={},
+o={[v]:h,[w]:[{[x]:g},"supportsFIPS"]},
+p={[x]:g},
+q={[v]:c,[w]:[true,{[v]:h,[w]:[p,"supportsDualStack"]}]},
+r=[l],
+s=[m],
+t=[{[x]:"Region"}];
+const _data={version:"1.0",parameters:{Region:i,UseDualStack:j,UseFIPS:j,Endpoint:i},rules:[{conditions:[{[v]:b,[w]:[k]}],rules:[{conditions:r,error:"Invalid Configuration: FIPS and custom endpoint are not supported",type:d},{conditions:s,error:"Invalid Configuration: Dualstack and custom endpoint are not supported",type:d},{endpoint:{url:k,properties:n,headers:n},type:e}],type:f},{conditions:[{[v]:b,[w]:t}],rules:[{conditions:[{[v]:"aws.partition",[w]:t,assign:g}],rules:[{conditions:[l,m],rules:[{conditions:[{[v]:c,[w]:[a,o]},q],rules:[{endpoint:{url:"https://connect-fips.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:n,headers:n},type:e}],type:f},{error:"FIPS and DualStack are enabled, but this partition does not support one or both",type:d}],type:f},{conditions:r,rules:[{conditions:[{[v]:c,[w]:[o,a]}],rules:[{conditions:[{[v]:"stringEquals",[w]:[{[v]:h,[w]:[p,"name"]},"aws-us-gov"]}],endpoint:{url:"https://connect.{Region}.amazonaws.com",properties:n,headers:n},type:e},{endpoint:{url:"https://connect-fips.{Region}.{PartitionResult#dnsSuffix}",properties:n,headers:n},type:e}],type:f},{error:"FIPS is enabled but this partition does not support FIPS",type:d}],type:f},{conditions:s,rules:[{conditions:[q],rules:[{endpoint:{url:"https://connect.{Region}.{PartitionResult#dualStackDnsSuffix}",properties:n,headers:n},type:e}],type:f},{error:"DualStack is enabled but this partition does not support DualStack",type:d}],type:f},{endpoint:{url:"https://connect.{Region}.{PartitionResult#dnsSuffix}",properties:n,headers:n},type:e}],type:f}],type:f},{error:"Invalid Configuration: Missing Region",type:d}]};
export const ruleSet: RuleSetObject = _data;
diff --git a/clients/client-connect/src/index.ts b/clients/client-connect/src/index.ts
index abfdd05ca756..404007ca6fb2 100644
--- a/clients/client-connect/src/index.ts
+++ b/clients/client-connect/src/index.ts
@@ -7,9 +7,9 @@
* contact routing. You can also resolve customer issues more efficiently by getting customers in
* touch with the appropriate agents.
There are limits to the number of Amazon Connect resources that you can create. There - * are also limits to the number of requests that you can make per second. For more information, see - * Amazon Connect Service Quotas in the Amazon Connect Administrator - * Guide.
+ * are also limits to the number of requests that you can make per second. For more information, + * seeP98941055 Amazon Connect Service + * Quotas in the Amazon Connect Administrator Guide. *You can connect programmatically to an Amazon Web Services service by using an endpoint. For * a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
* diff --git a/clients/client-connect/src/models/models_0.ts b/clients/client-connect/src/models/models_0.ts index f39875d117b2..d2840b9f9e72 100644 --- a/clients/client-connect/src/models/models_0.ts +++ b/clients/client-connect/src/models/models_0.ts @@ -1419,7 +1419,7 @@ export interface CreateContactFlowRequest { /** * @public *The JSON string that represents the content of the flow. For an example, see Example - * contact flow in Amazon Connect Flow language.
+ * flow in Amazon Connect Flow language. *Length Constraints: Minimum length of 1. Maximum length of 256000.
*/ Content: string | undefined; @@ -1510,7 +1510,8 @@ export interface CreateContactFlowModuleRequest { /** * @public - *The content of the flow module.
+ *The JSON string that represents the content of the flow. For an example, see Example + * flow in Amazon Connect Flow language.
*/ Content: string | undefined; @@ -3287,7 +3288,8 @@ export interface Application { /** * @public - *The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
The permissions that the agent is granted on the application. Only the ACCESS
+ * permission is supported.
The JSON string that represents the content of the flow. For an example, see Example - * contact flow in Amazon Connect Flow language.
+ * flow in Amazon Connect Flow language. + *Length Constraints: Minimum length of 1. Maximum length of 256000.
*/ Content?: string; @@ -5596,8 +5599,7 @@ export interface ContactFlowModule { /** * @public *The JSON string that represents the content of the flow. For an example, see Example - * contact flow in Amazon Connect Flow language.
- *Length Constraints: Minimum length of 1. Maximum length of 256000.
+ * flow in Amazon Connect Flow language. */ Content?: string; @@ -6259,20 +6261,17 @@ export type PhoneNumberWorkflowStatus = (typeof PhoneNumberWorkflowStatus)[keyof *
- * CLAIMED means the previous ClaimedPhoneNumber or
- * UpdatePhoneNumber operation succeeded.
CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
*
- * IN_PROGRESS means a ClaimedPhoneNumber or
- * UpdatePhoneNumber operation is still in progress and has not yet completed. You can
- * call DescribePhoneNumber at a later time to verify if the previous operation has
- * completed.
IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed.
+ * You can call DescribePhoneNumber at
+ * a later time to verify if the previous operation has completed.
*
- * FAILED indicates that the previous ClaimedPhoneNumber or
- * UpdatePhoneNumber operation has failed. It will include a message indicating the
+ * FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the
* failure reason. A common reason for a failure may be that the TargetArn value you
* are claiming or updating a phone number to has reached its limit of total claimed numbers. If
* you received a FAILED status from a ClaimPhoneNumber API call, you
@@ -6373,20 +6372,17 @@ export interface ClaimedPhoneNumberSummary {
*
- * CLAIMED means the previous ClaimedPhoneNumber or
- * UpdatePhoneNumber operation succeeded.
CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
*
- * IN_PROGRESS means a ClaimedPhoneNumber or
- * UpdatePhoneNumber operation is still in progress and has not yet completed. You can
- * call DescribePhoneNumber at a later time to verify if the previous operation has
- * completed.
IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed.
+ * You can call DescribePhoneNumber at
+ * a later time to verify if the previous operation has completed.
*
- * FAILED indicates that the previous ClaimedPhoneNumber or
- * UpdatePhoneNumber operation has failed. It will include a message indicating the
+ * FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the
* failure reason. A common reason for a failure may be that the TargetArn value you
* are claiming or updating a phone number to has reached its limit of total claimed numbers. If
* you received a FAILED status from a ClaimPhoneNumber API call, you
@@ -7032,7 +7028,7 @@ export interface TrafficDistributionGroup {
*
- * UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup operation is still in progress and has not yet
+ * UPDATE_IN_PROGRESS means the previous UpdateTrafficDistribution operation is still in progress and has not yet
* completed.
DeleteTrafficDistributionGroup API. The default traffic distribution group is deleted as
* part of the process for deleting a replica.
* You can change the SignInConfig distribution only for a
- * default TrafficDistributionGroup (see the IsDefault parameter in the
- * TrafficDistributionGroup
- * data type). If you call
- * UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,
- * an InvalidRequestException is returned.
The SignInConfig distribution is available only on the default
+ * TrafficDistributionGroup. If you call UpdateTrafficDistribution with
+ * a modified SignInConfig and a non-default TrafficDistributionGroup, an
+ * InvalidRequestException is returned.
- * FIFTEEN_MIN: The
- * difference between StartTime and EndTime must be less than 3
- * days.
FIFTEEN_MIN: The difference between StartTime and
+ * EndTime must be less than 3 days.
* @@ -1790,8 +1789,8 @@ export interface GetMetricDataV2Request { * @public *
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the
* retrieval of historical metrics data. The time must be before the end time timestamp. The start
- * and end time depends on the IntervalPeriod selected. By default the time range between
- * start and end time is 35 days. Historical metrics are available for 3 months.
IntervalPeriod selected. By default the time range
+ * between start and end time is 35 days. Historical metrics are available for 3 months.
*/
StartTime: Date | undefined;
@@ -1821,8 +1820,8 @@ export interface GetMetricDataV2Request {
*
- * FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3
- * days.
FIFTEEN_MIN: The difference between StartTime and
+ * EndTime must be less than 3 days.
* @@ -1996,7 +1995,8 @@ export interface GetMetricDataV2Request { *
*Valid groupings and filters: Queue, Channel, Routing Profile, Agent, Agent Hierarchy
*The Negate key in Metric Level Filters is not applicable for this metric.
The Negate key in Metric Level Filters is not applicable for this
+ * metric.
The distribution of allowing signing in to the instance and its replica(s).
+ *The distribution that determines which Amazon Web Services Regions should be used to sign in + * agents in to both the instance and its replica(s).
*/ export interface SignInConfig { /** @@ -2544,7 +2545,8 @@ export interface GetTrafficDistributionResponse { /** * @public - *The distribution of allowing signing in to the instance and its replica(s).
+ *The distribution that determines which Amazon Web Services Regions should be used to sign in + * agents in to both the instance and its replica(s).
*/ SignInConfig?: SignInConfig; @@ -7414,7 +7416,9 @@ export interface StartTaskContactRequest { /** * @public - *The identifier of the previous chat, voice, or task contact.
+ *The identifier of the previous chat, voice, or task contact. Any updates to user-defined
+ * attributes to task contacts linked using the same PreviousContactID will affect
+ * every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
+ *A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have
+ * the following reference types at the time of creation: URL | NUMBER |
+ * STRING | DATE | EMAIL. ATTACHMENT is not a
+ * supported reference type during task creation.
A unique identifier for the task template.
+ *A unique identifier for the task template. For more information about task templates, see Create task templates in the + * Amazon Connect Administrator Guide.
*/ TaskTemplateId?: string; /** * @public - *The identifier for the quick connect.
+ *The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the
+ * flow that is defined on agent or queue quick connect. For more information about quick connects,
+ * see Create quick
+ * connects.
The contactId that is related to this contact.
+ *The contactId that is related to this contact. Linking
+ * tasks together by using RelatedContactID copies over contact attributes from the
+ * related task contact to the new task contact. All updates to user-defined attributes in the new
+ * task contact are limited to the individual contact ID, unlike what happens when tasks are linked
+ * by using PreviousContactID. There are no limits to the number of contacts that can
+ * be linked by using RelatedContactId.
The JSON string that represents the content of the flow. For an example, see Example - * contact flow in Amazon Connect Flow language.
+ * flow in Amazon Connect Flow language. *Length Constraints: Minimum length of 1. Maximum length of 256000.
*/ Content: string | undefined; @@ -8044,7 +8060,7 @@ export interface UpdateContactFlowModuleContentRequest { /** * @public *The JSON string that represents the content of the flow. For an example, see Example - * contact flow in Amazon Connect Flow language.
+ * flow in Amazon Connect Flow language. */ Content: string | undefined; } diff --git a/clients/client-connect/src/models/models_2.ts b/clients/client-connect/src/models/models_2.ts index ea17c421b1bd..e000d0656440 100644 --- a/clients/client-connect/src/models/models_2.ts +++ b/clients/client-connect/src/models/models_2.ts @@ -155,6 +155,32 @@ export interface UpdatePhoneNumberResponse { PhoneNumberArn?: string; } +/** + * @public + */ +export interface UpdatePhoneNumberMetadataRequest { + /** + * @public + *The Amazon Resource Name (ARN) or resource ID of the phone number.
+ */ + PhoneNumberId: string | undefined; + + /** + * @public + *The description of the phone number.
+ */ + PhoneNumberDescription?: string; + + /** + * @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 */ @@ -758,7 +784,8 @@ export interface UpdateTrafficDistributionRequest { /** * @public - *The distribution of allowing signing in to the instance and its replica(s).
+ *The distribution that determines which Amazon Web Services Regions should be used to sign in + * agents in to both the instance and its replica(s).
*/ SignInConfig?: SignInConfig; @@ -1894,6 +1921,9 @@ export interface SearchUsersRequest { /** * @public *The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
+ *InstanceID is a required field. The "Required: No" below is incorrect.
+ *The version of the evaluation form to activate. If the version property is not provided, the\n latest version of the evaluation form is activated.
", "smithy.api#required": {} } @@ -184,6 +185,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A version of the evaluation form.
", "smithy.api#required": {} } @@ -1149,6 +1151,9 @@ { "target": "com.amazonaws.connect#UpdatePhoneNumber" }, + { + "target": "com.amazonaws.connect#UpdatePhoneNumberMetadata" + }, { "target": "com.amazonaws.connect#UpdatePrompt" }, @@ -1240,7 +1245,7 @@ "name": "connect" }, "aws.protocols#restJson1": {}, - "smithy.api#documentation": "Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.
\nAmazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.
\nThere are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator\n Guide.
\nYou can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
", + "smithy.api#documentation": "Amazon Connect is a cloud-based contact center solution that you use to set up and\n manage a customer contact center and provide reliable customer engagement at any scale.
\nAmazon Connect provides metrics and real-time reporting that enable you to optimize\n contact routing. You can also resolve customer issues more efficiently by getting customers in\n touch with the appropriate agents.
\nThere are limits to the number of Amazon Connect resources that you can create. There\n are also limits to the number of requests that you can make per second. For more information,\n seeP98941055 Amazon Connect Service\n Quotas in the Amazon Connect Administrator Guide.
\nYou can connect programmatically to an Amazon Web Services service by using an endpoint. For\n a list of Amazon Connect endpoints, see Amazon Connect Endpoints.
", "smithy.api#title": "Amazon Connect Service", "smithy.rules#endpointRuleSet": { "version": "1.0", @@ -1284,7 +1289,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1327,7 +1331,8 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1340,7 +1345,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1354,7 +1358,6 @@ "assign": "PartitionResult" } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1377,7 +1380,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1412,7 +1414,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1423,14 +1424,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1444,14 +1447,12 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ - true, { "fn": "getAttr", "argv": [ @@ -1460,18 +1461,17 @@ }, "supportsFIPS" ] - } + }, + true ] } ], - "type": "tree", "rules": [ { "conditions": [ { "fn": "stringEquals", "argv": [ - "aws-us-gov", { "fn": "getAttr", "argv": [ @@ -1480,7 +1480,8 @@ }, "name" ] - } + }, + "aws-us-gov" ] } ], @@ -1500,14 +1501,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [ @@ -1521,7 +1524,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [ @@ -1541,7 +1543,6 @@ ] } ], - "type": "tree", "rules": [ { "conditions": [], @@ -1552,14 +1553,16 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -1570,9 +1573,11 @@ }, "type": "endpoint" } - ] + ], + "type": "tree" } - ] + ], + "type": "tree" }, { "conditions": [], @@ -2074,7 +2079,7 @@ "ApplicationPermissions": { "target": "com.amazonaws.connect#ApplicationPermissions", "traits": { - "smithy.api#documentation": "The permissions that the agent is granted on the application. Only the ACCESS permission is supported.
The permissions that the agent is granted on the application. Only the ACCESS\n permission is supported.
The status of the phone number.
\n\n CLAIMED means the previous ClaimedPhoneNumber or\n UpdatePhoneNumber operation succeeded.
\n IN_PROGRESS means a ClaimedPhoneNumber or\n UpdatePhoneNumber operation is still in progress and has not yet completed. You can\n call DescribePhoneNumber at a later time to verify if the previous operation has\n completed.
\n FAILED indicates that the previous ClaimedPhoneNumber or\n UpdatePhoneNumber operation has failed. It will include a message indicating the\n failure reason. A common reason for a failure may be that the TargetArn value you\n are claiming or updating a phone number to has reached its limit of total claimed numbers. If\n you received a FAILED status from a ClaimPhoneNumber API call, you\n have one day to retry claiming the phone number before the number is released back to the\n inventory for other customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming\n fails.
\nThe status of the phone number.
\n\n CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
\n IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed.\n You can call DescribePhoneNumber at\n a later time to verify if the previous operation has completed.
\n FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the\n failure reason. A common reason for a failure may be that the TargetArn value you\n are claiming or updating a phone number to has reached its limit of total claimed numbers. If\n you received a FAILED status from a ClaimPhoneNumber API call, you\n have one day to retry claiming the phone number before the number is released back to the\n inventory for other customers to claim.
You will not be billed for the phone number during the 1-day period if number claiming\n fails.
\nThe JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
" + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
" } }, "Tags": { @@ -3604,7 +3612,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowModuleContent", "traits": { - "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
" + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n flow in Amazon Connect Flow language.
" } }, "Description": { @@ -4329,7 +4337,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowModuleContent", "traits": { - "smithy.api#documentation": "The content of the flow module.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n flow in Amazon Connect Flow language.
", "smithy.api#required": {} } }, @@ -4405,7 +4413,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowContent", "traits": { - "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
", "smithy.api#required": {} } }, @@ -5811,7 +5819,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
\nYou can change the SignInConfig distribution only for a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Creates a traffic distribution group given an Amazon Connect instance that has been replicated.
\nThe SignInConfig distribution is available only on a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
For more information about creating traffic distribution groups, see Set up traffic distribution groups in\n the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/traffic-distribution-group", @@ -6003,7 +6011,7 @@ } ], "traits": { - "smithy.api#documentation": "Creates a user account for the specified Amazon Connect instance.
\nFor information about how to create user accounts using the Amazon Connect console, see\n Add\n Users in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Creates a user account for the specified Amazon Connect instance.
\nCertain UserIdentityInfo parameters\n are required in some situations. For example, Email is required if you are using\n SAML for identity management. FirstName and LastName are required if\n you are using Amazon Connect or SAML for identity management.
For information about how to create user accounts using the Amazon Connect console, see\n Add\n Users in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/users/{InstanceId}", @@ -6845,6 +6853,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A version of the evaluation form. If the version property is not provided, the latest version of the\n evaluation form is deactivated.
", "smithy.api#required": {} } @@ -6874,6 +6883,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of the deactivated evaluation form resource.
", "smithy.api#required": {} } @@ -7187,6 +7197,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The unique identifier for the evaluation form.
", "smithy.api#httpQuery": "version" } @@ -8682,6 +8693,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "A version of the evaluation form.
", "smithy.api#httpQuery": "version" } @@ -11032,6 +11044,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A version of the evaluation form.
", "smithy.api#required": {} } @@ -11129,6 +11142,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A version of the evaluation form.
", "smithy.api#required": {} } @@ -11777,6 +11791,7 @@ "LatestVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version number of the latest evaluation form version.
", "smithy.api#required": {} } @@ -11784,6 +11799,7 @@ "ActiveVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "The version of the active evaluation form version.
" } } @@ -11850,6 +11866,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A version of the evaluation form.
", "smithy.api#required": {} } @@ -12611,7 +12628,7 @@ } ], "traits": { - "smithy.api#documentation": "Retrieves a token for federation.
\nThis API doesn't support root users. If you try to invoke GetFederationToken with root\n credentials, an error message similar to the following one appears:
\n\n Provided identity: Principal: .... User: .... cannot be used for federation with\n Amazon Connect\n
Supports SAML sign-in for Amazon Connect. Retrieves a token for federation. The token is\n for the Amazon Connect user which corresponds to the IAM credentials that were\n used to invoke this action.
\nFor more information about how SAML sign-in works in Amazon Connect, see Configure SAML with\n IAM for Amazon Connect in the Amazon Connect Administrator\n Guide.\n
\nThis API doesn't support root users. If you try to invoke GetFederationToken with root\n credentials, an error message similar to the following one appears:
\n\n Provided identity: Principal: .... User: .... cannot be used for federation with\n Amazon Connect\n
Gets historical metric data from the specified Amazon Connect instance.
\nFor a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Gets historical metric data from the specified Amazon Connect instance.
\nFor a description of each historical metric, see Historical Metrics\n Definitions in the Amazon Connect Administrator Guide.
\nWe recommend using the GetMetricDataV2 API. It\n provides more flexibility, features, and the ability to query longer time ranges than\n GetMetricData. Use it to retrieve historical agent and contact metrics for the\n last 3 months, at varying intervals. You can also use it to build custom dashboards to measure\n historical queue and agent performance. For example, you can track the number of incoming\n contacts for the last 7 days, with data split by day, to see how contact volume changed per day\n of the week.
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be before the end time timestamp. The start\n and end time depends on the IntervalPeriod selected. By default the time range between\n start and end time is 35 days. Historical metrics are available for 3 months.
The timestamp, in UNIX Epoch time format, at which to start the reporting interval for the\n retrieval of historical metrics data. The time must be before the end time timestamp. The start\n and end time depends on the IntervalPeriod selected. By default the time range\n between start and end time is 35 days. Historical metrics are available for 3 months.
The interval period and timezone to apply to returned metrics.
\n\n IntervalPeriod: An aggregated grouping applied to request metrics. Valid\n IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN |\n HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime differs by 1 day, then Amazon Connect\n returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By\n default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and\n EndTime based on which IntervalPeriod is requested.
\n FIFTEEN_MIN: The difference between StartTime and EndTime must be less than 3\n days.
\n THIRTY_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n HOUR: The difference between StartTime and\n EndTime must be less than 3 days.
\n DAY: The difference between StartTime and EndTime\n must be less than 35 days.
\n WEEK: The difference between StartTime and\n EndTime must be less than 35 days.
\n TOTAL: The difference between StartTime and\n EndTime must be less than 35 days.
\n TimeZone: The timezone applied to requested metrics.
The interval period and timezone to apply to returned metrics.
\n\n IntervalPeriod: An aggregated grouping applied to request metrics. Valid\n IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN |\n HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime differs by 1 day, then Amazon Connect\n returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By\n default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and\n EndTime based on which IntervalPeriod is requested.
\n FIFTEEN_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n THIRTY_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n HOUR: The difference between StartTime and\n EndTime must be less than 3 days.
\n DAY: The difference between StartTime and EndTime\n must be less than 35 days.
\n WEEK: The difference between StartTime and\n EndTime must be less than 35 days.
\n TOTAL: The difference between StartTime and\n EndTime must be less than 35 days.
\n TimeZone: The timezone applied to requested metrics.
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.
\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: 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
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\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
\nThe Negate key in Metric Level Filters is not applicable for this metric.
Unit: 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: 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, 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.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\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
\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, 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.
\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: 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
\nData for this metric is available starting from October 1, 2023 0:00:00 GMT.
\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
\nThe Negate key in Metric Level Filters is not applicable for this\n metric.
Unit: 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: 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, 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.
\nUnit: Seconds
\nValid groupings and filters: Queue, Channel, Routing Profile
\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
\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, 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 distribution of allowing signing in to the instance and its replica(s).
" + "smithy.api#documentation": "The distribution that determines which Amazon Web Services Regions should be used to sign in\n agents in to both the instance and its replica(s).
" } }, "AgentConfig": { @@ -14723,7 +14740,7 @@ "IntervalPeriod": { "target": "com.amazonaws.connect#IntervalPeriod", "traits": { - "smithy.api#documentation": "\n IntervalPeriod: An aggregated grouping applied to request metrics. Valid\n IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN |\n HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime differs by 1 day, then Amazon Connect\n returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By\n default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime\n based on what IntervalPeriod is requested.
\n FIFTEEN_MIN: The\n difference between StartTime and EndTime must be less than 3\n days.
\n THIRTY_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n HOUR: The difference between StartTime and EndTime\n must be less than 3 days.
\n DAY: The difference between StartTime and EndTime\n must be less than 35 days.
\n WEEK: The difference between StartTime and EndTime\n must be less than 35 days.
\n TOTAL: The difference between StartTime and EndTime\n must be less than 35 days.
\n IntervalPeriod: An aggregated grouping applied to request metrics. Valid\n IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN |\n HOUR | DAY | WEEK | TOTAL.
For example, if IntervalPeriod is selected THIRTY_MIN,\n StartTime and EndTime differs by 1 day, then Amazon Connect\n returns 48 results in the response. Each result is aggregated by the THIRTY_MIN period. By\n default Amazon Connect aggregates results based on the TOTAL interval period.
The following list describes restrictions on StartTime and EndTime\n based on what IntervalPeriod is requested.
\n FIFTEEN_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n THIRTY_MIN: The difference between StartTime and\n EndTime must be less than 3 days.
\n HOUR: The difference between StartTime and EndTime\n must be less than 3 days.
\n DAY: The difference between StartTime and EndTime\n must be less than 35 days.
\n WEEK: The difference between StartTime and EndTime\n must be less than 35 days.
\n TOTAL: The difference between StartTime and EndTime\n must be less than 35 days.
The token for the next set of results. The next set of results can be retrieved by using the \n token value returned in the previous response when making the next request.
", + "smithy.api#documentation": "The token for the next set of results. The next set of results can be retrieved by using the\n token value returned in the previous response when making the next request.
", "smithy.api#httpQuery": "nextToken" } }, @@ -17747,7 +17764,7 @@ "NextToken": { "target": "com.amazonaws.connect#NextToken", "traits": { - "smithy.api#documentation": "The token for the next set of results. The next set of results can be retrieved by using the \n token value returned in the previous response when making the next request.
" + "smithy.api#documentation": "The token for the next set of results. The next set of results can be retrieved by using the\n token value returned in the previous response when making the next request.
" } } }, @@ -21212,7 +21229,7 @@ } }, "traits": { - "smithy.api#documentation": "The status of the phone number.
\n\n CLAIMED means the previous ClaimedPhoneNumber or\n UpdatePhoneNumber operation succeeded.
\n IN_PROGRESS means a ClaimedPhoneNumber or\n UpdatePhoneNumber operation is still in progress and has not yet completed. You can\n call DescribePhoneNumber at a later time to verify if the previous operation has\n completed.
\n FAILED indicates that the previous ClaimedPhoneNumber or\n UpdatePhoneNumber operation has failed. It will include a message indicating the\n failure reason. A common reason for a failure may be that the TargetArn value you\n are claiming or updating a phone number to has reached its limit of total claimed numbers. If\n you received a FAILED status from a ClaimPhoneNumber API call, you\n have one day to retry claiming the phone number before the number is released back to the\n inventory for other customers to claim.
The status of the phone number.
\n\n CLAIMED means the previous ClaimPhoneNumber or UpdatePhoneNumber operation succeeded.
\n IN_PROGRESS means a ClaimPhoneNumber, UpdatePhoneNumber, or UpdatePhoneNumberMetadata operation is still in progress and has not yet completed.\n You can call DescribePhoneNumber at\n a later time to verify if the previous operation has completed.
\n FAILED indicates that the previous ClaimPhoneNumber or UpdatePhoneNumber operation has failed. It will include a message indicating the\n failure reason. A common reason for a failure may be that the TargetArn value you\n are claiming or updating a phone number to has reached its limit of total claimed numbers. If\n you received a FAILED status from a ClaimPhoneNumber API call, you\n have one day to retry claiming the phone number before the number is released back to the\n inventory for other customers to claim.
Searches users in an Amazon Connect instance, with optional filtering.
\n\n AfterContactWorkTimeLimit is returned in milliseconds.
Searches users in an Amazon Connect instance, with optional filtering.
\n\n AfterContactWorkTimeLimit is returned in milliseconds.
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
" + "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.
\nInstanceID is a required field. The \"Required: No\" below is incorrect.
\nThe distribution of allowing signing in to the instance and its replica(s).
" + "smithy.api#documentation": "The distribution that determines which Amazon Web Services Regions should be used to sign in\n agents in to both the instance and its replica(s).
" } }, "com.amazonaws.connect#SignInDistribution": { @@ -25607,7 +25624,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates a flow to start a new task.
", + "smithy.api#documentation": "Initiates a flow to start a new task contact. For more information about task contacts, see\n Concepts: Tasks in\n Amazon Connect in the Amazon Connect Administrator Guide.
\nWhen using PreviousContactId and RelatedContactId input\n parameters, note the following:
\n PreviousContactId\n
Any updates to user-defined task contact attributes on any contact linked through the\n same PreviousContactId will affect every contact in the chain.
There can be a maximum of 12 linked task contacts in a chain. That is, 12 task contacts\n can be created that share the same PreviousContactId.
\n RelatedContactId\n
Copies contact attributes from the related task contact to the new contact.
\nAny update on attributes in a new task contact does not update attributes on previous\n contact.
\nThere’s no limit on the number of task contacts that can be created that use the same\n RelatedContactId.
In addition, when calling StartTaskContact include only one of these parameters:\n ContactFlowID, QuickConnectID, or TaskTemplateID. Only\n one parameter is required as long as the task template has a flow configured to run it. If more\n than one parameter is specified, or only the TaskTemplateID is specified but it does\n not have a flow configured, the request returns an error because Amazon Connect cannot\n identify the unique flow to run when the task is created.
A ServiceQuotaExceededException occurs when the number of open tasks exceeds\n the active tasks quota or there are already 12 tasks referencing the same\n PreviousContactId. For more information about service quotas for task contacts, see\n Amazon Connect service quotas in the Amazon Connect Administrator\n Guide.
The identifier of the previous chat, voice, or task contact.
" + "smithy.api#documentation": "The identifier of the previous chat, voice, or task contact. Any updates to user-defined\n attributes to task contacts linked using the same PreviousContactID will affect\n every contact in the chain. There can be a maximum of 12 linked task contacts in a chain.
A formatted URL that is shown to an agent in the Contact Control Panel (CCP).
" + "smithy.api#documentation": "A formatted URL that is shown to an agent in the Contact Control Panel (CCP). Tasks can have\n the following reference types at the time of creation: URL | NUMBER |\n STRING | DATE | EMAIL. ATTACHMENT is not a\n supported reference type during task creation.
A unique identifier for the task template.
" + "smithy.api#documentation": "A unique identifier for the task template. For more information about task templates, see Create task templates in the\n Amazon Connect Administrator Guide.
" } }, "QuickConnectId": { "target": "com.amazonaws.connect#QuickConnectId", "traits": { - "smithy.api#documentation": "The identifier for the quick connect.
" + "smithy.api#documentation": "The identifier for the quick connect. Tasks that are created by using QuickConnectId will use the\n flow that is defined on agent or queue quick connect. For more information about quick connects,\n see Create quick\n connects.
The contactId that is related to this contact.
" + "smithy.api#documentation": "The contactId that is related to this contact. Linking\n tasks together by using RelatedContactID copies over contact attributes from the\n related task contact to the new task contact. All updates to user-defined attributes in the new\n task contact are limited to the individual contact ID, unlike what happens when tasks are linked\n by using PreviousContactID. There are no limits to the number of contacts that can\n be linked by using RelatedContactId.
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.
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 UpdateTrafficDistribution 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.
You can change the SignInConfig distribution only for a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). If you call\n UpdateTrafficDistribution with a modified SignInConfig and a non-default TrafficDistributionGroup,\n an InvalidRequestException is returned.
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 SignInConfig distribution is available only on the default\n TrafficDistributionGroup. If you call UpdateTrafficDistribution with\n a modified SignInConfig and a non-default TrafficDistributionGroup, an\n InvalidRequestException is returned.
The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n flow in Amazon Connect Flow language.
\nLength Constraints: Minimum length of 1. Maximum length of 256000.
", "smithy.api#required": {} } } @@ -27898,7 +27915,7 @@ "Content": { "target": "com.amazonaws.connect#ContactFlowModuleContent", "traits": { - "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n contact flow in Amazon Connect Flow language.
", + "smithy.api#documentation": "The JSON string that represents the content of the flow. For an example, see Example\n flow in Amazon Connect Flow language.
", "smithy.api#required": {} } } @@ -28265,6 +28282,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "A version of the evaluation form to update.
", "smithy.api#required": {} } @@ -28272,6 +28290,7 @@ "CreateNewVersion": { "target": "com.amazonaws.connect#BoxedBoolean", "traits": { + "smithy.api#default": null, "smithy.api#documentation": "A flag indicating whether the operation must create a new version.
" } }, @@ -28333,6 +28352,7 @@ "EvaluationFormVersion": { "target": "com.amazonaws.connect#VersionNumber", "traits": { + "smithy.api#default": 0, "smithy.api#documentation": "The version of the updated evaluation form resource.
", "smithy.api#required": {} } @@ -28702,6 +28722,78 @@ } } }, + "com.amazonaws.connect#UpdatePhoneNumberMetadata": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#UpdatePhoneNumberMetadataRequest" + }, + "output": { + "target": "smithy.api#Unit" + }, + "errors": [ + { + "target": "com.amazonaws.connect#AccessDeniedException" + }, + { + "target": "com.amazonaws.connect#IdempotencyException" + }, + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceInUseException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "Updates a phone number’s metadata.
\nTo verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.
\nThe Amazon Resource Name (ARN) or resource ID of the phone number.
", + "smithy.api#httpLabel": {}, + "smithy.api#required": {} + } + }, + "PhoneNumberDescription": { + "target": "com.amazonaws.connect#PhoneNumberDescription", + "traits": { + "smithy.api#documentation": "The description of the phone number.
" + } + }, + "ClientToken": { + "target": "com.amazonaws.connect#ClientToken", + "traits": { + "smithy.api#documentation": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the\n request. If not provided, the Amazon Web Services\n SDK populates this field. For more information about idempotency, see\n Making retries safe with idempotent APIs.
", + "smithy.api#idempotencyToken": {} + } + } + }, + "traits": { + "smithy.api#input": {} + } + }, "com.amazonaws.connect#UpdatePhoneNumberRequest": { "type": "structure", "members": { @@ -30047,7 +30139,7 @@ } ], "traits": { - "smithy.api#documentation": "Updates the traffic distribution for a given traffic distribution group.
\nYou can change the SignInConfig distribution only for a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). 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#documentation": "Updates the traffic distribution for a given traffic distribution group.
\nThe SignInConfig distribution is available only on a \ndefault TrafficDistributionGroup (see the IsDefault parameter in the \nTrafficDistributionGroup\n data type). 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}", @@ -30075,7 +30167,7 @@ "SignInConfig": { "target": "com.amazonaws.connect#SignInConfig", "traits": { - "smithy.api#documentation": "The distribution of allowing signing in to the instance and its replica(s).
" + "smithy.api#documentation": "The distribution that determines which Amazon Web Services Regions should be used to sign in\n agents in to both the instance and its replica(s).
" } }, "AgentConfig": { @@ -31317,6 +31409,7 @@ "com.amazonaws.connect#VersionNumber": { "type": "integer", "traits": { + "smithy.api#default": 0, "smithy.api#range": { "min": 1 }