Skip to content
AWS for Query.Farm

aws.connectcases.search_cases

Example SQL Queries

SELECT * FROM
aws.connectcases.search_cases
WHERE
"domain_id" = 'VALUE';

Description

Searches for cases within their associated Cases domain. Search results are returned as a paginated list of abridged case documents.

For customer_id you must provide the full customer profile ARN in this format: arn:aws:profile:your AWS Region:your AWS account ID:domains/profiles domain name/profiles/profile ID.

Table Definition

Column NameColumn Data Type
domain_id Required Input Column

The unique identifier of the Cases domain. 

VARCHAR
filter Input Column

A list of filter objects.

STRUCT(
    "field" STRUCT(
        "contains" STRUCT(
            "id" VARCHAR,
            "value" STRUCT(
                "boolean_value" BOOLEAN,
                "double_value" DOUBLE,
                "empty_value" BOOLEAN,
                "string_value" VARCHAR,
                "user_arn_value" VARCHAR
            )
        ),
        "equal_to" STRUCT(
            "id" VARCHAR,
            "value" STRUCT(
                "boolean_value" BOOLEAN,
                "double_value" DOUBLE,
                "empty_value" BOOLEAN,
                "string_value" VARCHAR,
                "user_arn_value" VARCHAR
            )
        ),
        "greater_than" STRUCT(
            "id" VARCHAR,
            "value" STRUCT(
                "boolean_value" BOOLEAN,
                "double_value" DOUBLE,
                "empty_value" BOOLEAN,
                "string_value" VARCHAR,
                "user_arn_value" VARCHAR
            )
        ),
        "greater_than_or_equal_to" STRUCT(
            "id" VARCHAR,
            "value" STRUCT(
                "boolean_value" BOOLEAN,
                "double_value" DOUBLE,
                "empty_value" BOOLEAN,
                "string_value" VARCHAR,
                "user_arn_value" VARCHAR
            )
        ),
        "less_than" STRUCT(
            "id" VARCHAR,
            "value" STRUCT(
                "boolean_value" BOOLEAN,
                "double_value" DOUBLE,
                "empty_value" BOOLEAN,
                "string_value" VARCHAR,
                "user_arn_value" VARCHAR
            )
        ),
        "less_than_or_equal_to" STRUCT(
            "id" VARCHAR,
            "value" STRUCT(
                "boolean_value" BOOLEAN,
                "double_value" DOUBLE,
                "empty_value" BOOLEAN,
                "string_value" VARCHAR,
                "user_arn_value" VARCHAR
            )
        )
    )
)
Show child fields
filter.field

A list of fields to filter on.

Show child fields
filter.field.contains

Object containing field identifier and value information.

Show child fields
filter.field.contains.id

Unique identifier of a field.

filter.field.contains.value

Union of potential field value types.

Show child fields
filter.field.contains.value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

filter.field.contains.value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

filter.field.contains.value.empty_value

An empty value.

filter.field.contains.value.string_value

String value type.

filter.field.contains.value.user_arn_value

Represents the user that performed the audit.

filter.field.equal_to

Object containing field identifier and value information.

Show child fields
filter.field.equal_to.id

Unique identifier of a field.

filter.field.equal_to.value

Union of potential field value types.

Show child fields
filter.field.equal_to.value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

filter.field.equal_to.value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

filter.field.equal_to.value.empty_value

An empty value.

filter.field.equal_to.value.string_value

String value type.

filter.field.equal_to.value.user_arn_value

Represents the user that performed the audit.

filter.field.greater_than

Object containing field identifier and value information.

Show child fields
filter.field.greater_than.id

Unique identifier of a field.

filter.field.greater_than.value

Union of potential field value types.

Show child fields
filter.field.greater_than.value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

filter.field.greater_than.value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

filter.field.greater_than.value.empty_value

An empty value.

filter.field.greater_than.value.string_value

String value type.

filter.field.greater_than.value.user_arn_value

Represents the user that performed the audit.

filter.field.greater_than_or_equal_to

Object containing field identifier and value information.

Show child fields
filter.field.greater_than_or_equal_to.id

Unique identifier of a field.

filter.field.greater_than_or_equal_to.value

Union of potential field value types.

Show child fields
filter.field.greater_than_or_equal_to.value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

filter.field.greater_than_or_equal_to.value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

filter.field.greater_than_or_equal_to.value.empty_value

An empty value.

filter.field.greater_than_or_equal_to.value.string_value

String value type.

filter.field.greater_than_or_equal_to.value.user_arn_value

Represents the user that performed the audit.

filter.field.less_than

Object containing field identifier and value information.

Show child fields
filter.field.less_than.id

Unique identifier of a field.

filter.field.less_than.value

Union of potential field value types.

Show child fields
filter.field.less_than.value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

filter.field.less_than.value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

filter.field.less_than.value.empty_value

An empty value.

filter.field.less_than.value.string_value

String value type.

filter.field.less_than.value.user_arn_value

Represents the user that performed the audit.

filter.field.less_than_or_equal_to

Object containing field identifier and value information.

Show child fields
filter.field.less_than_or_equal_to.id

Unique identifier of a field.

filter.field.less_than_or_equal_to.value

Union of potential field value types.

Show child fields
filter.field.less_than_or_equal_to.value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

filter.field.less_than_or_equal_to.value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

filter.field.less_than_or_equal_to.value.empty_value

An empty value.

filter.field.less_than_or_equal_to.value.string_value

String value type.

filter.field.less_than_or_equal_to.value.user_arn_value

Represents the user that performed the audit.

search_term Input Column

A word or phrase used to perform a quick search.

VARCHAR
sorts Input Column

A list of sorts where each sort specifies a field and their sort order to be applied to the results. 

STRUCT(
    "field_id" VARCHAR,
    "sort_order" VARCHAR
)[]
Show child fields
sorts[]
Show child fields
sorts[].field_id

Unique identifier of a field.

sorts[].sort_order

A structured set of sort terms

_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_input_fields Input Column
STRUCT(
    "id" VARCHAR
)[]
Show child fields
_input_fields[]
Show child fields
_input_fields[].id

Unique identifier of a field.

case_id

A unique identifier of the case.

VARCHAR
fields

List of case field values.

STRUCT(
    "id" VARCHAR,
    "value" STRUCT(
        "boolean_value" BOOLEAN,
        "double_value" DOUBLE,
        "empty_value" BOOLEAN,
        "string_value" VARCHAR,
        "user_arn_value" VARCHAR
    )
)[]
Show child fields
fields[]
Show child fields
fields[].id

Unique identifier of a field.

fields[].value

Union of potential field value types.

Show child fields
fields[].value.boolean_value

Can be either null, or have a Boolean value type. Only one value can be provided.

fields[].value.double_value

Can be either null, or have a Double number value type. Only one value can be provided.

fields[].value.empty_value

An empty value.

fields[].value.string_value

String value type.

fields[].value.user_arn_value

Represents the user that performed the audit.

tags

A map of of key-value pairs that represent tags on a resource. Tags are used to organize, track, or control access for this resource.

MAP(VARCHAR, VARCHAR)
template_id

A unique identifier of a template.

VARCHAR