CloudSearch / Client / describe_scaling_parameters

describe_scaling_parameters#

CloudSearch.Client.describe_scaling_parameters(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.describe_scaling_parameters(
    DomainName='string'
)
Parameters:

DomainName (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'ScalingParameters': {
        'Options': {
            'DesiredInstanceType': 'search.m1.small'|'search.m1.large'|'search.m2.xlarge'|'search.m2.2xlarge'|'search.m3.medium'|'search.m3.large'|'search.m3.xlarge'|'search.m3.2xlarge'|'search.small'|'search.medium'|'search.large'|'search.xlarge'|'search.2xlarge'|'search.previousgeneration.small'|'search.previousgeneration.large'|'search.previousgeneration.xlarge'|'search.previousgeneration.2xlarge',
            'DesiredReplicationCount': 123,
            'DesiredPartitionCount': 123
        },
        'Status': {
            'CreationDate': datetime(2015, 1, 1),
            'UpdateDate': datetime(2015, 1, 1),
            'UpdateVersion': 123,
            'State': 'RequiresIndexDocuments'|'Processing'|'Active'|'FailedToValidate',
            'PendingDeletion': True|False
        }
    }
}

Response Structure

  • (dict) –

    The result of a DescribeScalingParameters request. Contains the scaling parameters configured for the domain specified in the request.

    • ScalingParameters (dict) –

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

      • Options (dict) –

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

        • DesiredInstanceType (string) –

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

        • DesiredReplicationCount (integer) –

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

        • DesiredPartitionCount (integer) –

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

      • Status (dict) –

        The status of domain configuration option.

        • CreationDate (datetime) –

          A timestamp for when this option was created.

        • UpdateDate (datetime) –

          A timestamp for when this option was last updated.

        • UpdateVersion (integer) –

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

        • State (string) –

          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.

        • PendingDeletion (boolean) –

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

Exceptions