Skip to content

describe_availability_options async 

describe_availability_options(
    domain_name: DomainName,
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
    deployed: Optional[Boolean] = None,
) -> DescribeAvailabilityOptionsResponse

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.

Parameters:

  • domain_name (DomainName) –

    The name of the domain you want to describe.

  • deployed (Optional[Boolean], default: None ) –

    Whether to display the deployed configuration (true) or include any pending changes (false). Defaults to false.

Raises:

Source code in docs_src/capo_cloudsearch/_services/async_cloud_search.py 
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
async def describe_availability_options(
    self,
    domain_name: "capo_cloudsearch.types.domain_name.DomainName",
    *,
    config_overrides: Optional[AsyncCloudSearchClientConfig] = None,
    deployed: Optional["capo_cloudsearch.types.boolean.Boolean"] = None,
) -> "capo_cloudsearch.types.describe_availability_options_response.DescribeAvailabilityOptionsResponse":
    """<p>Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the <code>Deployed</code> option to <code>true</code> to show the active configuration and exclude pending changes. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-availability-options.html" target="_blank">Configuring Availability Options</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>

    Args:
        domain_name: <p>The name of the domain you want to describe.</p>
        deployed: <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>

    Raises:
        capo_cloudsearch.errors.base_exception.BaseException: <p>An error occurred while processing the request.</p>
        capo_cloudsearch.errors.disabled_operation_exception.DisabledOperationException: <p>The request was rejected because it attempted an operation which is not enabled.</p>
        capo_cloudsearch.errors.internal_exception.InternalException: <p>An internal error occurred while processing the request. If this problem persists, report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
        capo_cloudsearch.errors.invalid_type_exception.InvalidTypeException: <p>The request was rejected because it specified an invalid type definition.</p>
        capo_cloudsearch.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because a resource limit has already been met.</p>
        capo_cloudsearch.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
        capo_cloudsearch.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudsearch.types.describe_availability_options_request.DescribeAvailabilityOptionsRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudsearch.types.describe_availability_options_response.DescribeAvailabilityOptionsResponse"
    ]:
        import capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_availability_options

        (
            output,
            http_response,
        ) = await capo_cloudsearch._operations.a9_search_cloud_config_service2013.describe_availability_options.async_describe_availability_options(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeAvailabilityOptions")
    )
    input_: capo_cloudsearch.types.describe_availability_options_request.DescribeAvailabilityOptionsRequest = {
        "domain_name": domain_name
    }
    if deployed is not None:
        input_["deployed"] = deployed

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output