CreateUseCase
Creates a use case for an integration association.
Request Syntax
PUT /instance/InstanceId/integration-associations/IntegrationAssociationId/use-cases HTTP/1.1
Content-type: application/json
{
"Tags": {
"string" : "string"
},
"UseCaseType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- IntegrationAssociationId
-
The identifier for the integration association.
Length Constraints: Minimum length of 1. Maximum length of 200.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- Tags
-
The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Type: String to string map
Map Entries: Maximum number of 50 items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$Value Length Constraints: Maximum length of 256.
Required: No
- UseCaseType
-
The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
Type: String
Valid Values:
RULES_EVALUATION | CONNECT_CAMPAIGNSRequired: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"UseCaseArn": "string",
"UseCaseId": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- UseCaseArn
-
The Amazon Resource Name (ARN) for the use case.
Type: String
- UseCaseId
-
The identifier of the use case.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 200.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DuplicateResourceException
-
A resource with the specified name already exists.
HTTP Status Code: 409
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
