get_change_token_status ¶

def get_change_token_status(
    self,
    change_token: "capo_waf_regional.types.change_token.ChangeToken",
    *,
    config_overrides: Optional[WAFRegionalClientConfig] = None,
) -> "capo_waf_regional.types.get_change_token_status_response.GetChangeTokenStatusResponse":
    """<note> <p>This is <b>AWS WAF Classic</b> documentation. For more information, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html">AWS WAF Classic</a> in the developer guide.</p> <p> <b>For the latest version of AWS WAF</b>, use the AWS WAFV2 API and see the <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html">AWS WAF Developer Guide</a>. With the latest version, AWS WAF has a single set of endpoints for regional and global use. </p> </note> <p>Returns the status of a <code>ChangeToken</code> that you got by calling <a>GetChangeToken</a>. <code>ChangeTokenStatus</code> is one of the following values:</p> <ul> <li> <p> <code>PROVISIONED</code>: You requested the change token by calling <code>GetChangeToken</code>, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.</p> </li> <li> <p> <code>PENDING</code>: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.</p> </li> <li> <p> <code>INSYNC</code>: Propagation is complete.</p> </li> </ul>

    Args:
        change_token: <p>The change token for which you want to get the status. This change token was previously returned in the <code>GetChangeToken</code> response.</p>

    Raises:
        capo_waf_regional.errors.waf_internal_error_exception.WAFInternalErrorException: <p>The operation failed because of a system problem, even though the request was valid. Retry your request.</p>
        capo_waf_regional.errors.waf_nonexistent_item_exception.WAFNonexistentItemException: <p>The operation failed because the referenced object doesn't exist.</p>
        capo_waf_regional.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To get the change token status
        The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.

        >>> client.get_change_token_status(change_token='abcd12f2-46da-4fdb-b8d5-fbd4c466928f')
    """

    def _handler(
        req: "OperationRequest[capo_waf_regional.types.get_change_token_status_request.GetChangeTokenStatusRequest]",
    ) -> OperationResponse[
        "capo_waf_regional.types.get_change_token_status_response.GetChangeTokenStatusResponse"
    ]:
        import capo_waf_regional._operations.awswaf_regional_20161128.get_change_token_status

        output, http_response = (
            capo_waf_regional._operations.awswaf_regional_20161128.get_change_token_status.get_change_token_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetChangeTokenStatus")
    )
    input_: capo_waf_regional.types.get_change_token_status_request.GetChangeTokenStatusRequest = {
        "change_token": change_token
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output