[ aws . connect ]

search-evaluation-forms

Description

Searches evaluation forms in an Amazon Connect instance, with optional filtering.

Use cases

Following are common uses cases for this API:

• List all evaluation forms in an instance.
• Find all evaluation forms that meet specific criteria, such as Title, Description, Status, and more.
• Find all evaluation forms that are tagged with a specific set of tags.

Important things to know

• A Search operation, unlike a List operation, takes time to index changes to resource (create, update or delete). If you don’t see updated information for recently changed contact evaluations, try calling the API again in a few seconds.

Endpoints : See Amazon Connect endpoints and quotas .

See also: AWS API Documentation

Synopsis

  search-evaluation-forms
--instance-id <value>
[--next-token <value>]
[--max-results <value>]
[--search-criteria <value>]
[--search-filter <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--instance-id (string) [required]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Constraints:

• min: 1
• max: 100

--next-token (string)

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

--max-results (integer)

The maximum number of results to return per page.

Constraints:

• min: 1
• max: 100

--search-criteria (structure)

The search criteria to be used to return evaluation forms.

OrConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(structure)

The search criteria to be used to return evaluation forms.

OrConditions -> (list)

A list of conditions which would be applied together with an OR condition.

( … recursive … )

AndConditions -> (list)

A list of conditions which would be applied together with an AND condition.

( … recursive … )

StringCondition -> (structure)

A leaf node condition which can be used to specify a string condition.

FieldName -> (string)

The name of the field in the string condition.

Value -> (string)

The value of the string.

ComparisonType -> (string)

The type of comparison to be made when evaluating the string condition.

Possible values:

• STARTS_WITH
• CONTAINS
• EXACT

NumberCondition -> (structure)

A leaf node condition which can be used to specify a numeric condition.

Note

The currently supported value for FieldName is limit .

FieldName -> (string)

The name of the field in the number condition.

MinValue -> (integer)

The minValue to be used while evaluating the number condition.

MaxValue -> (integer)

The maxValue to be used while evaluating the number condition.

ComparisonType -> (string)

The type of comparison to be made when evaluating the number condition.

Possible values:

• GREATER_OR_EQUAL
• GREATER
• LESSER_OR_EQUAL
• LESSER
• EQUAL
• NOT_EQUAL
• RANGE

BooleanCondition -> (structure)

Boolean search condition.

FieldName -> (string)

A name of the property to be searched.

ComparisonType -> (string)

Boolean property comparison type.

Possible values:

• IS_TRUE
• IS_FALSE

DateTimeCondition -> (structure)

Datetime search condition.

FieldName -> (string)

A name of the datetime property to be searched

MinValue -> (string)

A minimum value of the property.

Constraints:

• pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$

MaxValue -> (string)

A maximum value of the property.

Constraints:

• pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$

ComparisonType -> (string)

Datetime property comparison type.

Possible values:

• GREATER_THAN
• LESS_THAN
• GREATER_THAN_OR_EQUAL_TO
• LESS_THAN_OR_EQUAL_TO
• EQUAL_TO
• RANGE

AndConditions -> (list)

A list of conditions which would be applied together with an AND condition.

(structure)

The search criteria to be used to return evaluation forms.

OrConditions -> (list)

A list of conditions which would be applied together with an OR condition.

( … recursive … )

AndConditions -> (list)

A list of conditions which would be applied together with an AND condition.

( … recursive … )

StringCondition -> (structure)

A leaf node condition which can be used to specify a string condition.

FieldName -> (string)

The name of the field in the string condition.

Value -> (string)

The value of the string.

ComparisonType -> (string)

The type of comparison to be made when evaluating the string condition.

Possible values:

• STARTS_WITH
• CONTAINS
• EXACT

NumberCondition -> (structure)

A leaf node condition which can be used to specify a numeric condition.

Note

The currently supported value for FieldName is limit .

FieldName -> (string)

The name of the field in the number condition.

MinValue -> (integer)

The minValue to be used while evaluating the number condition.

MaxValue -> (integer)

The maxValue to be used while evaluating the number condition.

ComparisonType -> (string)

The type of comparison to be made when evaluating the number condition.

Possible values:

• GREATER_OR_EQUAL
• GREATER
• LESSER_OR_EQUAL
• LESSER
• EQUAL
• NOT_EQUAL
• RANGE

BooleanCondition -> (structure)

Boolean search condition.

FieldName -> (string)

A name of the property to be searched.

ComparisonType -> (string)

Boolean property comparison type.

Possible values:

• IS_TRUE
• IS_FALSE

DateTimeCondition -> (structure)

Datetime search condition.

FieldName -> (string)

A name of the datetime property to be searched

MinValue -> (string)

A minimum value of the property.

Constraints:

• pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$

MaxValue -> (string)

A maximum value of the property.

Constraints:

• pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$

ComparisonType -> (string)

Datetime property comparison type.

Possible values:

• GREATER_THAN
• LESS_THAN
• GREATER_THAN_OR_EQUAL_TO
• LESS_THAN_OR_EQUAL_TO
• EQUAL_TO
• RANGE

StringCondition -> (structure)

A leaf node condition which can be used to specify a string condition.

FieldName -> (string)

The name of the field in the string condition.

Value -> (string)

The value of the string.

ComparisonType -> (string)

The type of comparison to be made when evaluating the string condition.

Possible values:

• STARTS_WITH
• CONTAINS
• EXACT

NumberCondition -> (structure)

A leaf node condition which can be used to specify a numeric condition.

Note

The currently supported value for FieldName is limit .

FieldName -> (string)

The name of the field in the number condition.

MinValue -> (integer)

The minValue to be used while evaluating the number condition.

MaxValue -> (integer)

The maxValue to be used while evaluating the number condition.

ComparisonType -> (string)

The type of comparison to be made when evaluating the number condition.

Possible values:

• GREATER_OR_EQUAL
• GREATER
• LESSER_OR_EQUAL
• LESSER
• EQUAL
• NOT_EQUAL
• RANGE

BooleanCondition -> (structure)

Boolean search condition.

FieldName -> (string)

A name of the property to be searched.

ComparisonType -> (string)

Boolean property comparison type.

Possible values:

• IS_TRUE
• IS_FALSE

DateTimeCondition -> (structure)

Datetime search condition.

FieldName -> (string)

A name of the datetime property to be searched

MinValue -> (string)

A minimum value of the property.

Constraints:

• pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$

MaxValue -> (string)

A maximum value of the property.

Constraints:

• pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{3})?Z?$

ComparisonType -> (string)

Datetime property comparison type.

Possible values:

• GREATER_THAN
• LESS_THAN
• GREATER_THAN_OR_EQUAL_TO
• LESS_THAN_OR_EQUAL_TO
• EQUAL_TO
• RANGE

JSON Syntax:

{
  "OrConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      },
      "NumberCondition": {
        "FieldName": "string",
        "MinValue": integer,
        "MaxValue": integer,
        "ComparisonType": "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
      },
      "BooleanCondition": {
        "FieldName": "string",
        "ComparisonType": "IS_TRUE"|"IS_FALSE"
      },
      "DateTimeCondition": {
        "FieldName": "string",
        "MinValue": "string",
        "MaxValue": "string",
        "ComparisonType": "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"RANGE"
      }
    }
    ...
  ],
  "AndConditions": [
    {
      "OrConditions": [
        { ... recursive ... }
        ...
      ],
      "AndConditions": [
        { ... recursive ... }
        ...
      ],
      "StringCondition": {
        "FieldName": "string",
        "Value": "string",
        "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
      },
      "NumberCondition": {
        "FieldName": "string",
        "MinValue": integer,
        "MaxValue": integer,
        "ComparisonType": "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
      },
      "BooleanCondition": {
        "FieldName": "string",
        "ComparisonType": "IS_TRUE"|"IS_FALSE"
      },
      "DateTimeCondition": {
        "FieldName": "string",
        "MinValue": "string",
        "MaxValue": "string",
        "ComparisonType": "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"RANGE"
      }
    }
    ...
  ],
  "StringCondition": {
    "FieldName": "string",
    "Value": "string",
    "ComparisonType": "STARTS_WITH"|"CONTAINS"|"EXACT"
  },
  "NumberCondition": {
    "FieldName": "string",
    "MinValue": integer,
    "MaxValue": integer,
    "ComparisonType": "GREATER_OR_EQUAL"|"GREATER"|"LESSER_OR_EQUAL"|"LESSER"|"EQUAL"|"NOT_EQUAL"|"RANGE"
  },
  "BooleanCondition": {
    "FieldName": "string",
    "ComparisonType": "IS_TRUE"|"IS_FALSE"
  },
  "DateTimeCondition": {
    "FieldName": "string",
    "MinValue": "string",
    "MaxValue": "string",
    "ComparisonType": "GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL_TO"|"LESS_THAN_OR_EQUAL_TO"|"EQUAL_TO"|"RANGE"
  }
}

--search-filter (structure)

Filters to be applied to search results.

AttributeFilter -> (structure)

An object that can be used to specify Tag conditions inside the SearchFilter . This accepts an OR or AND (List of List) input where:

• The top level list specifies conditions that need to be applied with OR operator.
• The inner list specifies conditions that need to be applied with AND operator.

OrConditions -> (list)

A list of conditions which would be applied together with an OR condition.

(structure)

A list of conditions which would be applied together with an AND condition.

TagConditions -> (list)

A leaf node condition which can be used to specify a tag condition.

(structure)

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

TagKey -> (string)

The tag key in the tag condition.

TagValue -> (string)

The tag value in the tag condition.

AndCondition -> (structure)

A list of conditions which would be applied together with an AND condition.

TagConditions -> (list)

A leaf node condition which can be used to specify a tag condition.

(structure)

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

TagKey -> (string)

The tag key in the tag condition.

TagValue -> (string)

The tag value in the tag condition.

TagCondition -> (structure)

A leaf node condition which can be used to specify a tag condition, for example, HAVE BPO = 123 .

TagKey -> (string)

The tag key in the tag condition.

TagValue -> (string)

The tag value in the tag condition.

JSON Syntax:

{
  "AttributeFilter": {
    "OrConditions": [
      {
        "TagConditions": [
          {
            "TagKey": "string",
            "TagValue": "string"
          }
          ...
        ]
      }
      ...
    ],
    "AndCondition": {
      "TagConditions": [
        {
          "TagKey": "string",
          "TagValue": "string"
        }
        ...
      ]
    },
    "TagCondition": {
      "TagKey": "string",
      "TagValue": "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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

EvaluationFormSearchSummaryList -> (list)

Information about the returned evaluation forms.

(structure)

Information about the returned evaluation forms.

EvaluationFormId -> (string) [required]

The unique identifier for the evaluation form.

Constraints:

• min: 1
• max: 500

EvaluationFormArn -> (string) [required]

The Amazon Resource Name (ARN) for the evaluation form resource.

Title -> (string) [required]

The title of the evaluation form.

Constraints:

• min: 1
• max: 128

Status -> (string) [required]

The status of the evaluation form.

Possible values:

• DRAFT
• ACTIVE

Description -> (string)

The description of the evaluation form.

Constraints:

• min: 0
• max: 1024

CreatedTime -> (timestamp) [required]

When the evaluation form was created.

CreatedBy -> (string) [required]

Who created the evaluation form.

LastModifiedTime -> (timestamp) [required]

When the evaluation form was last changed.

LastModifiedBy -> (string) [required]

Who changed the evaluation form.

LastActivatedTime -> (timestamp)

When the evaluation format was last activated.

LastActivatedBy -> (string)

The ID of user who last activated evaluation form.

LatestVersion -> (integer) [required]

Latest version of the evaluation form.

Constraints:

• min: 1

ActiveVersion -> (integer)

Active version of the evaluation form.

Constraints:

• min: 1

AutoEvaluationEnabled -> (boolean)

Whether automated evaluation is enabled.

Tags -> (map)

The tags used to organize, track, or control access for this resource. For example, { “Tags”: {“key1”:”value1”, “key2”:”value2”} }.

Constraints:

• min: 1
• max: 50

key -> (string)

Constraints:

• min: 1
• max: 128
• pattern: ^(?!aws:)[\p{L}\p{Z}\p{N}_.:/=+\-@]*$

value -> (string)

Constraints:

• max: 256

NextToken -> (string)

If there are additional results, this is the token for the next set of results.

ApproximateTotalCount -> (long)

The total number of evaluation forms that matched your search query.