CloudSearch / Client / describe_availability_options

describe_availability_options#

CloudSearch.Client.describe_availability_options(**kwargs)#

Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.

See also: AWS API Documentation

Request Syntax

response = client.describe_availability_options(
    DomainName='string',
    Deployed=True|False
)
Parameters:

  • DomainName (string) –

    [REQUIRED]

    The name of the domain you want to describe.

  • Deployed (boolean) – Whether to display the deployed configuration ( true) or include any pending changes ( false). Defaults 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 DescribeAvailabilityOptions request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request.

    • AvailabilityOptions (dict) –

      The availability options configured for the domain. 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