Skip to content
AWS for Query.Farm

aws.cloudsearch.describe_scaling_parameters

Example SQL Queries

SELECT * FROM
aws.cloudsearch.describe_scaling_parameters
WHERE
"domain_name" = 'VALUE';

Description

Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide.

Table Definition

Column NameColumn Data Type
domain_name Required Input Column

A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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

_aws_region Input Column

The AWS region to use.

VARCHAR
scaling_parameters

The status and configuration of a search domain's scaling parameters. 

STRUCT(
    "options" STRUCT(
        "desired_instance_type" VARCHAR,
        "desired_replication_count" BIGINT,
        "desired_partition_count" BIGINT
    ),
    "status" STRUCT(
        "creation_date" TIMESTAMP_S,
        "update_date" TIMESTAMP_S,
        "update_version" BIGINT,
        "state" VARCHAR,
        "pending_deletion" BOOLEAN
    )
)
Show child fields
scaling_parameters.options

The desired instance type and desired number of replicas of each index partition.

Show child fields
scaling_parameters.options.desired_instance_type

The instance type that you want to preconfigure for your domain. For example, search.m1.small.

scaling_parameters.options.desired_partition_count

The number of partitions you want to preconfigure for your domain. Only valid when you select m2.2xlarge as the desired instance type.

scaling_parameters.options.desired_replication_count

The number of replicas you want to preconfigure for each index partition.

scaling_parameters.status

The status of domain configuration option.

Show child fields
scaling_parameters.status.creation_date

A timestamp for when this option was created.

scaling_parameters.status.pending_deletion

Indicates that the option will be deleted once processing is complete.

scaling_parameters.status.state

The state of processing a change to an option. Possible values:

  • RequiresIndexDocuments: the option's latest value will not be deployed until IndexDocuments has been called and indexing is complete.
  • Processing: the option's latest value is in the process of being activated.
  • Active: the option's latest value is completely deployed.
  • FailedToValidate: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.
scaling_parameters.status.update_date

A timestamp for when this option was last updated.

scaling_parameters.status.update_version

A unique integer that indicates when this option was last updated.