CloudSearch / Client / update_availability_options

update_availability_options#

CloudSearch.Client.update_availability_options(**kwargs)#

Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.update_availability_options(
    DomainName='string',
    MultiAZ=True|False
)
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).

  • MultiAZ (boolean) –

    [REQUIRED]

    You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to false.

Return type:

dict

Returns:

Response Syntax

{
    'AvailabilityOptions': {
        'Options': True|False,
        '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 UpdateAvailabilityOptions request. Contains the status of the domain’s availability options.

    • AvailabilityOptions (dict) –

      The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain.

      • Options (boolean) –

        The availability options configured for the domain.

      • 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