[ aws . connect ]

create-use-case

Description

Creates a use case for an integration association.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-use-case
--instance-id <value>
--integration-association-id <value>
--use-case-type <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--integration-association-id (string)

The identifier for the integration association.

--use-case-type (string)

The type of use case to associate to the integration association. Each integration association can have only one of each use case type.

Possible values:

  • RULES_EVALUATION

  • CONNECT_CAMPAIGNS

--tags (map)

One or more tags.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

UseCaseId -> (string)

The identifier of the use case.

UseCaseArn -> (string)

The Amazon Resource Name (ARN) for the use case.