AWS CLI Command Reference

Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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.

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 <value>]
[--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>]
[--v2-debug]

Options

--instance-id (string)

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

--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.

--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.

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.

BooleanCondition -> (structure)

Boolean search condition.

FieldName -> (string)

A name of the property to be searched.

ComparisonType -> (string)

Boolean property comparison type.

DateTimeCondition -> (structure)

Datetime search condition.

FieldName -> (string)

A name of the datetime property to be searched

MinValue -> (string)

A minimum value of the property.

MaxValue -> (string)

A maximum value of the property.

ComparisonType -> (string)

Datetime property comparison type.

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.

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.

BooleanCondition -> (structure)

Boolean search condition.

FieldName -> (string)

A name of the property to be searched.

ComparisonType -> (string)

Boolean property comparison type.

DateTimeCondition -> (structure)

Datetime search condition.

FieldName -> (string)

A name of the datetime property to be searched

MinValue -> (string)

A minimum value of the property.

MaxValue -> (string)

A maximum value of the property.

ComparisonType -> (string)

Datetime property comparison type.

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.

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.

BooleanCondition -> (structure)

Boolean search condition.

FieldName -> (string)

A name of the property to be searched.

ComparisonType -> (string)

Boolean property comparison type.

DateTimeCondition -> (structure)

Datetime search condition.

FieldName -> (string)

A name of the datetime property to be searched

MinValue -> (string)

A minimum value of the property.

MaxValue -> (string)

A maximum value of the property.

ComparisonType -> (string)

Datetime property comparison type.

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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

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

--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.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

EvaluationFormSearchSummaryList -> (list)

Information about the returned evaluation forms.

(structure)

Information about the returned evaluation forms.

EvaluationFormId -> (string)

The unique identifier for the evaluation form.

EvaluationFormArn -> (string)

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

Title -> (string)

The title of the evaluation form.

Status -> (string)

The status of the evaluation form.

Description -> (string)

The description of the evaluation form.

CreatedTime -> (timestamp)

When the evaluation form was created.

CreatedBy -> (string)

Who created the evaluation form.

LastModifiedTime -> (timestamp)

When the evaluation form was last changed.

LastModifiedBy -> (string)

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)

Latest version of the evaluation form.

ActiveVersion -> (integer)

Active version of the evaluation form.

AutoEvaluationEnabled -> (boolean)

Whether automated evaluation is enabled.

EvaluationFormLanguage -> (string)

The language of the evaluation form.

ContactInteractionType -> (string)

The contact interaction type for this evaluation form.

Tags -> (map)

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

key -> (string)

value -> (string)

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.