Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.
Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
A string representing the SMS verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "A string representing the email verification message.\n EmailVerificationMessage is allowed only if EmailSendingAccount is DEVELOPER.
This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "A string representing the email verification subject.\n EmailVerificationSubject is allowed only if EmailSendingAccount is DEVELOPER.
This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "VerificationMessageTemplate": { @@ -5780,18 +5796,18 @@ "ChallengeRequiredOnNewDevice": { "target": "com.amazonaws.cognitoidentityprovider#BooleanType", "traits": { - "smithy.api#documentation": "When true, device authentication can replace SMS and time-based one-time password (TOTP) factors for multi-factor authentication (MFA).
\nRegardless of the value of this field, users that sign in with new devices that have not been confirmed or remembered must provide a second factor if your user pool requires MFA.
\nWhen true, a remembered device can sign in with device authentication instead of SMS\n and time-based one-time password (TOTP) factors for multi-factor authentication\n (MFA).
\nWhether or not ChallengeRequiredOnNewDevice is true, users who sign in\n with devices that have not been confirmed or remembered must still provide a second\n factor in a user pool that requires MFA.
When true, Amazon Cognito doesn't remember newly-confirmed devices. Users who want to authenticate with their device \n can instead opt in to remembering their device. To collect a choice from your user, create an input prompt \n in your app and return the value that the user chooses in an UpdateDeviceStatus API request.
" + "smithy.api#documentation": "When true, Amazon Cognito doesn't automatically remember a user's device when your app sends a\n \n ConfirmDevice API request. In your app, create a prompt for\n your user to choose whether they want to remember their device. Return the user's choice\n in an \n UpdateDeviceStatus API request.
\nWhen DeviceOnlyRememberedOnUserPrompt is false, Amazon\n Cognito immediately remembers devices that you register in a ConfirmDevice\n API request.
The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.
\nWhen you provide a value for any DeviceConfiguration field, you activate the Amazon Cognito device-remembering feature.
The device-remembering configuration for a user pool. A \n DescribeUserPool request returns a null value for this object when the user\n pool isn't configured to remember devices. When device remembering is active, you can\n remember a user's device with a ConfirmDevice API request. Additionally. when the property\n DeviceOnlyRememberedOnUserPrompt is true, you must follow\n ConfirmDevice with an UpdateDeviceStatus API request that sets the user's device to\n remembered or not_remembered.
To sign in with a remembered device, include DEVICE_KEY in the\n authentication parameters in your user's \n InitiateAuth request. If your app doesn't include a DEVICE_KEY\n parameter, the response from Amazon Cognito includes newly-generated DEVICE_KEY and\n DEVICE_GROUP_KEY values under NewDeviceMetadata. Store\n these values to use in future device-authentication requests.
When you provide a value for any property of DeviceConfiguration, you\n activate the device remembering for the user pool.
Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.
Activates the propagation of additional user context data. For more information about\n propagation of user context data, see Adding advanced security to a user pool. If you don’t include this\n parameter, you can't send device fingerprint information, including source IP address,\n to Amazon Cognito advanced security. You can only activate\n EnablePropagateAdditionalUserContextData in an app client that has a\n client secret.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
A container with information about the SMS verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "The contents of the email verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "The subject of the email verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "VerificationMessageTemplate": { @@ -12719,6 +12741,12 @@ "traits": { "smithy.api#documentation": "When EnablePropagateAdditionalUserContextData is true, Amazon Cognito accepts an\n IpAddress value that you send in the UserContextData\n parameter. The UserContextData parameter sends information to Amazon Cognito\n advanced security for risk analysis. You can send UserContextData when you\n sign in Amazon Cognito native users with the InitiateAuth and\n RespondToAuthChallenge API operations.
When EnablePropagateAdditionalUserContextData is false, you can't send\n your user's source IP address to Amazon Cognito advanced security with unauthenticated API\n operations. EnablePropagateAdditionalUserContextData doesn't affect whether\n you can send a source IP address in a ContextData parameter with the\n authenticated API operations AdminInitiateAuth and\n AdminRespondToAuthChallenge.
You can only activate EnablePropagateAdditionalUserContextData in an app\n client that has a client secret. For more information about propagation of user context\n data, see Adding user device and session data to API requests.
Amazon Cognito creates a session token for each API request in an authentication flow. AuthSessionValidity is the duration, \nin minutes, of that session token. Your user pool native user must respond to each authentication challenge before the session expires.
The contents of the SMS verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "EmailVerificationMessage": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationMessageType", "traits": { - "smithy.api#documentation": "The contents of the email verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "EmailVerificationSubject": { "target": "com.amazonaws.cognitoidentityprovider#EmailVerificationSubjectType", "traits": { - "smithy.api#documentation": "The subject of the email verification message.
" + "smithy.api#documentation": "This parameter is no longer used. See VerificationMessageTemplateType.
" } }, "VerificationMessageTemplate": { diff --git a/codegen/sdk-codegen/aws-models/connect.json b/codegen/sdk-codegen/aws-models/connect.json index 37276b46ade..679c52a12bc 100644 --- a/codegen/sdk-codegen/aws-models/connect.json +++ b/codegen/sdk-codegen/aws-models/connect.json @@ -697,6 +697,12 @@ { "target": "com.amazonaws.connect#SearchAvailablePhoneNumbers" }, + { + "target": "com.amazonaws.connect#SearchQueues" + }, + { + "target": "com.amazonaws.connect#SearchRoutingProfiles" + }, { "target": "com.amazonaws.connect#SearchSecurityProfiles" }, @@ -2072,7 +2078,7 @@ } }, "traits": { - "smithy.api#documentation": "Filters user data based on the contact information that is associated to\n the users. It contains a list of contact states.
" + "smithy.api#documentation": "Filters user data based on the contact information that is associated to the users. It\n contains a list of contact states.
" } }, "com.amazonaws.connect#ContactFlow": { @@ -2099,7 +2105,7 @@ "Type": { "target": "com.amazonaws.connect#ContactFlowType", "traits": { - "smithy.api#documentation": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator\n Guide.
" + "smithy.api#documentation": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
" } }, "State": { @@ -2872,7 +2878,7 @@ "Type": { "target": "com.amazonaws.connect#ContactFlowType", "traits": { - "smithy.api#documentation": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator\n Guide.
", + "smithy.api#documentation": "The type of the flow. For descriptions of the available types, see Choose a flow type in the Amazon Connect Administrator Guide.
", "smithy.api#required": {} } }, @@ -3167,7 +3173,7 @@ "IntegrationArn": { "target": "com.amazonaws.connect#ARN", "traits": { - "smithy.api#documentation": "The Amazon Resource Name (ARN) of the integration.
\nWhen integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint instances must be in the same account.
\nThe Amazon Resource Name (ARN) of the integration.
\nWhen integrating with Amazon Pinpoint, the Amazon Connect and Amazon Pinpoint\n instances must be in the same account.
\nPermissions assigned to the security profile.
" + "smithy.api#documentation": "Permissions assigned to the security profile. For a list of valid permissions, see List of security\n profile permissions.
" } }, "InstanceId": { @@ -5199,7 +5205,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nDescribes the specified contact.
\nContact information remains available in Amazon Connect for 24 months, and then it is\n deleted.
\nThis API is in preview release for Amazon Connect and is subject to change.
\nDescribes the specified contact.
\nContact information remains available in Amazon Connect for 24 months, and then it is\n deleted.
\nOnly data from November 12, 2021, and later is returned by this\n API.
\nRemoves the flow association from a phone number claimed to your Amazon Connect instance, if\n a flow association exists.
", + "smithy.api#documentation": "Removes the flow association from a phone number claimed to your Amazon Connect instance, if a flow\n association exists.
", "smithy.api#http": { "method": "DELETE", "uri": "/phone-number/{PhoneNumberId}/contact-flow", @@ -7163,7 +7169,7 @@ "Filters": { "target": "com.amazonaws.connect#UserDataFilters", "traits": { - "smithy.api#documentation": "Filters up to 100 Queues, or up to 9 ContactStates. The user data is retrieved only for those users who are associated with\n the queues and have contacts that are in the specified ContactState.
Filters up to 100 Queues, or up to 9 ContactStates. The user data\n is retrieved only for those users who are associated with the queues and have contacts that are\n in the specified ContactState.
This API is in preview release for Amazon Connect and is subject to change.
\nFor the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently\n associated with the instance.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nFor the specified version of Amazon Lex, returns a paginated list of all the Amazon Lex bots currently\n associated with the instance. Use this API to returns both Amazon Lex V1 and V2\n bots.
", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/bots", @@ -9412,7 +9418,7 @@ } ], "traits": { - "smithy.api#documentation": "Provides information about the flows for the specified Amazon Connect instance.
\nYou can also create and update flows using the Amazon Connect\n Flow language.
\nFor more information about flows, see Flows in the\n Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Provides information about the flows for the specified Amazon Connect instance.
\nYou can also create and update flows using the Amazon Connect\n Flow language.
\nFor more information about flows, see Flows in the Amazon Connect\n Administrator Guide.
", "smithy.api#http": { "method": "GET", "uri": "/contact-flows-summary/{InstanceId}", @@ -10185,7 +10191,7 @@ } ], "traits": { - "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nReturns a paginated list of all the Amazon Lex bots currently associated with the\n instance.
", + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nReturns a paginated list of all the Amazon Lex V1 bots currently associated with the instance. To\n return both Amazon Lex V1 and V2 bots, use the ListBots API.\n
", "smithy.api#http": { "method": "GET", "uri": "/instance/{InstanceId}/lex-bots", @@ -11197,7 +11203,7 @@ "Permissions": { "target": "com.amazonaws.connect#PermissionsList", "traits": { - "smithy.api#documentation": "The permissions granted to the security profile.
" + "smithy.api#documentation": "The permissions granted to the security profile. For a complete list of valid permissions,\n see List\n of security profile permissions.
" } }, "NextToken": { @@ -11713,6 +11719,12 @@ } } }, + "com.amazonaws.connect#Long": { + "type": "long", + "traits": { + "smithy.api#box": {} + } + }, "com.amazonaws.connect#MaxResult10": { "type": "integer", "traits": { @@ -13514,7 +13526,7 @@ } }, "traits": { - "smithy.api#documentation": "Contains information about a queue for a quick connect. The flow must be of type\n Transfer to Queue.
" + "smithy.api#documentation": "Contains information about a queue for a quick connect. The flow must be of type Transfer to\n Queue.
" } }, "com.amazonaws.connect#QueueReference": { @@ -13537,6 +13549,58 @@ "smithy.api#documentation": "Contains information about a queue resource for which metrics are returned.
" } }, + "com.amazonaws.connect#QueueSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#QueueSearchCriteria" + } + }, + "com.amazonaws.connect#QueueSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#QueueSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#QueueSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + }, + "QueueTypeCondition": { + "target": "com.amazonaws.connect#SearchableQueueType", + "traits": { + "smithy.api#documentation": "The type of queue.
" + } + } + }, + "traits": { + "smithy.api#documentation": "The search criteria to be used to return queues.
" + } + }, + "com.amazonaws.connect#QueueSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "com.amazonaws.connect#QueueSearchSummaryList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#Queue" + } + }, "com.amazonaws.connect#QueueStatus": { "type": "string", "traits": { @@ -14254,6 +14318,18 @@ "traits": { "smithy.api#documentation": "The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.
" } + }, + "NumberOfAssociatedQueues": { + "target": "com.amazonaws.connect#Long", + "traits": { + "smithy.api#documentation": "The number of associated queues in routing profile.
" + } + }, + "NumberOfAssociatedUsers": { + "target": "com.amazonaws.connect#Long", + "traits": { + "smithy.api#documentation": "The number of associated users in routing profile.
" + } } }, "traits": { @@ -14272,6 +14348,12 @@ "com.amazonaws.connect#RoutingProfileId": { "type": "string" }, + "com.amazonaws.connect#RoutingProfileList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfile" + } + }, "com.amazonaws.connect#RoutingProfileName": { "type": "string", "traits": { @@ -14428,6 +14510,46 @@ "smithy.api#documentation": "Information about the routing profile assigned to the user.
" } }, + "com.amazonaws.connect#RoutingProfileSearchConditionList": { + "type": "list", + "member": { + "target": "com.amazonaws.connect#RoutingProfileSearchCriteria" + } + }, + "com.amazonaws.connect#RoutingProfileSearchCriteria": { + "type": "structure", + "members": { + "OrConditions": { + "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an OR condition.
" + } + }, + "AndConditions": { + "target": "com.amazonaws.connect#RoutingProfileSearchConditionList", + "traits": { + "smithy.api#documentation": "A list of conditions which would be applied together with an AND condition.
" + } + }, + "StringCondition": { + "target": "com.amazonaws.connect#StringCondition" + } + }, + "traits": { + "smithy.api#documentation": "The search criteria to be used to return routing profiles.
" + } + }, + "com.amazonaws.connect#RoutingProfileSearchFilter": { + "type": "structure", + "members": { + "TagFilter": { + "target": "com.amazonaws.connect#ControlPlaneTagFilter" + } + }, + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, "com.amazonaws.connect#RoutingProfileSummary": { "type": "structure", "members": { @@ -14587,6 +14709,206 @@ } } }, + "com.amazonaws.connect#SearchQueues": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchQueuesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchQueuesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nSearches queues in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-queues", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "Queues", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchQueuesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "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.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#QueueSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#QueueSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return queues.
" + } + } + } + }, + "com.amazonaws.connect#SearchQueuesResponse": { + "type": "structure", + "members": { + "Queues": { + "target": "com.amazonaws.connect#QueueSearchSummaryList", + "traits": { + "smithy.api#documentation": "Information about the queues.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of queues which matched your search query.
" + } + } + } + }, + "com.amazonaws.connect#SearchRoutingProfiles": { + "type": "operation", + "input": { + "target": "com.amazonaws.connect#SearchRoutingProfilesRequest" + }, + "output": { + "target": "com.amazonaws.connect#SearchRoutingProfilesResponse" + }, + "errors": [ + { + "target": "com.amazonaws.connect#InternalServiceException" + }, + { + "target": "com.amazonaws.connect#InvalidParameterException" + }, + { + "target": "com.amazonaws.connect#InvalidRequestException" + }, + { + "target": "com.amazonaws.connect#ResourceNotFoundException" + }, + { + "target": "com.amazonaws.connect#ThrottlingException" + } + ], + "traits": { + "smithy.api#documentation": "This API is in preview release for Amazon Connect and is subject to change.
\nSearches routing profiles in an Amazon Connect instance, with optional filtering.
", + "smithy.api#http": { + "method": "POST", + "uri": "/search-routing-profiles", + "code": 200 + }, + "smithy.api#paginated": { + "inputToken": "NextToken", + "outputToken": "NextToken", + "items": "RoutingProfiles", + "pageSize": "MaxResults" + } + } + }, + "com.amazonaws.connect#SearchRoutingProfilesRequest": { + "type": "structure", + "members": { + "InstanceId": { + "target": "com.amazonaws.connect#InstanceId", + "traits": { + "smithy.api#documentation": "The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.
", + "smithy.api#required": {} + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "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.
" + } + }, + "MaxResults": { + "target": "com.amazonaws.connect#MaxResult100", + "traits": { + "smithy.api#box": {}, + "smithy.api#documentation": "The maximum number of results to return per page.
" + } + }, + "SearchFilter": { + "target": "com.amazonaws.connect#RoutingProfileSearchFilter", + "traits": { + "smithy.api#documentation": "Filters to be applied to search results.
" + } + }, + "SearchCriteria": { + "target": "com.amazonaws.connect#RoutingProfileSearchCriteria", + "traits": { + "smithy.api#documentation": "The search criteria to be used to return routing profiles.
" + } + } + } + }, + "com.amazonaws.connect#SearchRoutingProfilesResponse": { + "type": "structure", + "members": { + "RoutingProfiles": { + "target": "com.amazonaws.connect#RoutingProfileList", + "traits": { + "smithy.api#documentation": "Information about the routing profiles.
" + } + }, + "NextToken": { + "target": "com.amazonaws.connect#NextToken2500", + "traits": { + "smithy.api#documentation": "If there are additional results, this is the token for the next set of results.
" + } + }, + "ApproximateTotalCount": { + "target": "com.amazonaws.connect#ApproximateTotalCount", + "traits": { + "smithy.api#documentation": "The total number of routing profiles which matched your search query.
" + } + } + } + }, "com.amazonaws.connect#SearchSecurityProfiles": { "type": "operation", "input": { @@ -14880,6 +15202,17 @@ } } }, + "com.amazonaws.connect#SearchableQueueType": { + "type": "string", + "traits": { + "smithy.api#enum": [ + { + "value": "STANDARD", + "name": "STANDARD" + } + ] + } + }, "com.amazonaws.connect#SecurityKey": { "type": "structure", "members": { @@ -15193,7 +15526,7 @@ } ], "traits": { - "smithy.api#documentation": "Initiates a flow to start a new chat for the customer. Response of this API provides\n a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
\n\nWhen a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
\n\nA 429 error occurs in the following situations:
\nAPI rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.
The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator\n Guide.
", + "smithy.api#documentation": "Initiates a flow to start a new chat for the customer. Response of this API provides a token\n required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
\n\nWhen a new chat contact is successfully created, clients must subscribe to the participant’s\n connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
\n\nA 429 error occurs in the following situations:
\nAPI rate limit is exceeded. API TPS throttling returns a TooManyRequests\n exception.
The quota for concurrent active\n chats is exceeded. Active chat throttling returns a\n LimitExceededException.
If you use the ChatDurationInMinutes parameter and receive a 400 error, your\n account may not support the ability to configure custom chat durations. For more information,\n contact Amazon Web Services Support.
For more information about chat, see Chat in the Amazon Connect Administrator\n Guide.
", "smithy.api#http": { "method": "PUT", "uri": "/contact/chat", @@ -15214,7 +15547,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the\n flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of\n the ARN, shown here in bold:
\narn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n
", + "smithy.api#documentation": "The identifier of the flow for initiating the chat.\n To\n see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow.\n On the flow page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:
\narn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n
", "smithy.api#required": {} } }, @@ -15461,7 +15794,7 @@ } ], "traits": { - "smithy.api#documentation": "Places an outbound call to a contact, and then initiates the flow. It performs the\n actions in the flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the flow places an outbound call to a contact, and then puts the contact in queue, the\n call is then routed to the agent, like any other inbound case.
\n\nThere is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.
\nUK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
\nCampaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request to the quota Amazon Connect campaigns.\n
Places an outbound call to a contact, and then initiates the flow. It performs the actions\n in the flow that's specified (in ContactFlowId).
Agents do not initiate the outbound API, which means that they do not dial the contact. If\n the flow places an outbound call to a contact, and then puts the contact in queue, the call is\n then routed to the agent, like any other inbound case.
\n\nThere is a 60-second dialing timeout for this operation. If the call is not connected after\n 60 seconds, it fails.
\nUK numbers with a 447 prefix are not allowed by default. Before you can dial these UK\n mobile numbers, you must submit a service quota increase request. For more information, see\n Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
\nCampaign calls are not allowed by default. Before you can make a call with\n TrafficType = CAMPAIGN, you must submit a service quota increase\n request to the quota Amazon Connect campaigns.
The\n identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect\n console user interface, on the navigation menu go to Routing,\n Contact Flows. Choose the flow. On the flow\n page, under the name of the flow, choose Show additional flow\n information. The ContactFlowId is the last part of the ARN, shown here in bold:
\narn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n
", + "smithy.api#documentation": "The\n identifier of the flow for the outbound call. To see the ContactFlowId in the Amazon Connect console user\n interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the\n flow, choose Show additional flow information. The ContactFlowId\n is the last part of the ARN, shown here in bold:
\narn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n
", "smithy.api#required": {} } }, @@ -15509,7 +15842,7 @@ "QueueId": { "target": "com.amazonaws.connect#QueueId", "traits": { - "smithy.api#documentation": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the\n phone number specified in the queue. If you do not specify a queue, the queue defined in the\n flow is used. If you do not specify a queue, you must specify a source phone\n number.
" + "smithy.api#documentation": "The queue for the call. If you specify a queue, the phone displayed for caller ID is the\n phone number specified in the queue. If you do not specify a queue, the queue defined in the flow\n is used. If you do not specify a queue, you must specify a source phone number.
" } }, "Attributes": { @@ -15605,7 +15938,7 @@ "ContactFlowId": { "target": "com.amazonaws.connect#ContactFlowId", "traits": { - "smithy.api#documentation": "The identifier of the flow for initiating the tasks. To see the ContactFlowId in the\n Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On\n the flow page, under the name of the flow, choose Show\n additional flow information. The ContactFlowId is the last part of the ARN, shown\n here in bold:
\narn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n
" + "smithy.api#documentation": "The identifier of the flow for initiating the tasks. To see the ContactFlowId in the Amazon Connect\n console user interface, on the navigation menu go to Routing,\n Contact Flows. Choose the flow. On the flow page, under the\n name of the flow, choose Show additional flow information. The\n ContactFlowId is the last part of the ARN, shown here in bold:
\narn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx\n
" } }, "Attributes": { @@ -16134,7 +16467,7 @@ } ], "traits": { - "smithy.api#documentation": "Adds the specified tags to the specified resource.
\nSome of the supported resource types are agents, routing profiles, queues, quick connects, contact\n flows, agent statuses, hours of operation, phone numbers, security profiles, and task\n templates. For a complete list, see Tagging resources in Amazon Connect.
\nFor sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Adds the specified tags to the specified resource.
\nSome of the supported resource types are agents, routing profiles, queues, quick connects,\n contact flows, agent statuses, hours of operation, phone numbers, security profiles, and task\n templates. For a complete list, see Tagging resources in Amazon Connect.
\nFor sample policies that use tags, see Amazon Connect Identity-Based\n Policy Examples in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "POST", "uri": "/tags/{resourceArn}", @@ -16585,7 +16918,7 @@ } ], "traits": { - "smithy.api#documentation": "Transfers contacts from one agent or queue to another agent or queue at any point after a\n contact is created. You can transfer a contact to another queue by providing the flow\n which orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.
\nNote the following requirements:
\nTransfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent\n flow, and Transfer to queue flow.
\nThe TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
\nTransfers contacts from one agent or queue to another agent or queue at any point after a\n contact is created. You can transfer a contact to another queue by providing the flow which\n orchestrates the contact to the destination queue. This gives you more control over contact\n handling and helps you adhere to the service level agreement (SLA) guaranteed to your\n customers.
\nNote the following requirements:
\nTransfer is supported for only TASK contacts.
Do not use both QueueId and UserId in the same call.
The following flow types are supported: Inbound flow, Transfer to agent flow, and Transfer\n to queue flow.
\nThe TransferContact API can be called only on active contacts.
A contact cannot be transferred more than 11 times.
\nCreates or updates\n user-defined contact attributes\n associated with the specified contact.
\nYou can create or update user-defined attributes for both ongoing and completed contacts.\n For example, while the call is active, you can update the customer's name or the reason the\n customer called. You can add notes about steps that the agent took during the call that display\n to the next agent that takes the call. You can also update attributes for a contact using data\n from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls\n for additional analysis, such as legal review or to identify abusive callers.
\nContact attributes are available in Amazon Connect for 24 months, and are then deleted. For\n information about contact record retention and the maximum size of the contact record attributes section, see Feature\n specifications in the Amazon Connect Administrator Guide.
", + "smithy.api#documentation": "Creates or updates\n user-defined contact attributes\n associated with the specified contact.
\nYou can create or update user-defined attributes for both ongoing and completed contacts.\n For example, while the call is active, you can update the customer's name or the reason the\n customer called. You can add notes about steps that the agent took during the call that display\n to the next agent that takes the call. You can also update attributes for a contact using data\n from your CRM application and save the data with the contact in Amazon Connect. You could also flag calls\n for additional analysis, such as legal review or to identify abusive callers.
\nContact attributes are available in Amazon Connect for 24 months, and are then deleted. For\n information about contact record retention and the maximum size of the contact record attributes\n section, see Feature\n specifications in the Amazon Connect Administrator Guide.
", "smithy.api#http": { "method": "POST", "uri": "/contact/attributes", @@ -16924,7 +17257,7 @@ "Attributes": { "target": "com.amazonaws.connect#Attributes", "traits": { - "smithy.api#documentation": "The Amazon Connect attributes. These attributes can be accessed in flows just like any other\n contact attributes.
\nYou can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.
", + "smithy.api#documentation": "The Amazon Connect attributes. These attributes can be accessed in flows just like any other contact\n attributes.
\nYou can have up to 32,768 UTF-8 bytes across all attributes for a contact. Attribute keys\n can include only alphanumeric, dash, and underscore characters.
", "smithy.api#required": {} } } @@ -17058,7 +17391,7 @@ "Name": { "target": "com.amazonaws.connect#ContactFlowName", "traits": { - "smithy.api#documentation": "TThe name of the flow.
" + "smithy.api#documentation": "The name of the flow.
" } }, "Description": { @@ -18471,7 +18804,7 @@ "Permissions": { "target": "com.amazonaws.connect#PermissionsList", "traits": { - "smithy.api#documentation": "The permissions granted to a security profile.
" + "smithy.api#documentation": "The permissions granted to a security profile. For a list of valid permissions,\n see List\n of security profile permissions.
" } }, "SecurityProfileId": { @@ -19280,13 +19613,13 @@ "MaxSlotsByChannel": { "target": "com.amazonaws.connect#ChannelToCountMap", "traits": { - "smithy.api#documentation": "A map of maximum slots by channel. The key is a channel name. The value is an integer: the\n maximum number of slots. This is calculated from MediaConcurrency of the RoutingProfile assigned to the agent.
" + "smithy.api#documentation": "A map of maximum slots by channel. The key is a channel name. The value is an integer: the\n maximum number of slots. This is calculated from MediaConcurrency of the\n RoutingProfile assigned to the agent.
" } }, "ActiveSlotsByChannel": { "target": "com.amazonaws.connect#ChannelToCountMap", "traits": { - "smithy.api#documentation": "A map of active slots by channel. The key is a channel name. The value is an integer: the\n number of active slots.
" + "smithy.api#documentation": "A map of active slots by channel. The key is a channel name. The value is an integer: the\n number of active slots.
" } }, "Contacts": { @@ -19312,7 +19645,7 @@ "ContactFilter": { "target": "com.amazonaws.connect#ContactFilter", "traits": { - "smithy.api#documentation": "A filter for the user data based on the contact information that is associated to the user. It\n contains a list of contact states.
" + "smithy.api#documentation": "A filter for the user data based on the contact information that is associated to the user.\n It contains a list of contact states.
" } } }, @@ -19498,7 +19831,7 @@ } }, "traits": { - "smithy.api#documentation": "The search criteria to be used to return users.
" + "smithy.api#documentation": "The search criteria to be used to return users.
\nThe Username, Firstname, and Lastname fields support\n \"contains\" queries with a minimum of 2 characters and a maximum of 25 characters. Any queries\n with character lengths outside of this range result in empty results.\n
A collection of settings that configure the RStudioServerPro Domain-level\n app.
The configuration for attaching a SageMaker user profile name to the execution role as a \n sts:SourceIdentity key.
A collection of RStudioServerPro Domain-level app settings to\n update.
The configuration for attaching a SageMaker user profile name to the execution role as a \n sts:SourceIdentity key. This configuration can only be modified if there are no apps in the InService or Pending state.