reset_distribution_cache ¶

reset_distribution_cache(
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    distribution_name: Optional[ResourceName] = None,
) -> ResetDistributionCacheResult

Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.

After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.

Parameters:

distribution_name (Optional[ResourceName], default: None ) –

The name of the distribution for which to reset cache.

Use the GetDistributions action to get a list of distribution names that you can specify.

Raises:

AccessDeniedException –

Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.
InvalidInputException –

Lightsail throws this exception when user input does not conform to the validation rules of an input field.

Domain and distribution APIs are only available in the N. Virginia (us-east-1) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to us-east-1 to create, view, or edit these resources.
NotFoundException –

Lightsail throws this exception when it cannot find a resource.
OperationFailureException –

Lightsail throws this exception when an operation fails to execute.
ServiceException –

A general service exception.
UnauthenticatedException –

Lightsail throws this exception when the user has not been authenticated.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_lightsail/_services/lightsail.py

def reset_distribution_cache(
    self,
    *,
    config_overrides: Optional[LightsailClientConfig] = None,
    distribution_name: Optional[
        "capo_lightsail.types.resource_name.ResourceName"
    ] = None,
) -> "capo_lightsail.types.reset_distribution_cache_result.ResetDistributionCacheResult":
    """<p>Deletes currently cached content from your Amazon Lightsail content delivery network (CDN) distribution.</p> <p>After resetting the cache, the next time a content request is made, your distribution pulls, serves, and caches it from the origin.</p>

    Args:
        distribution_name: <p>The name of the distribution for which to reset cache.</p> <p>Use the <code>GetDistributions</code> action to get a list of distribution names that you can specify.</p>

    Raises:
        capo_lightsail.errors.access_denied_exception.AccessDeniedException: <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
        capo_lightsail.errors.invalid_input_exception.InvalidInputException: <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p> <note> <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p> </note>
        capo_lightsail.errors.not_found_exception.NotFoundException: <p>Lightsail throws this exception when it cannot find a resource.</p>
        capo_lightsail.errors.operation_failure_exception.OperationFailureException: <p>Lightsail throws this exception when an operation fails to execute.</p>
        capo_lightsail.errors.service_exception.ServiceException: <p>A general service exception.</p>
        capo_lightsail.errors.unauthenticated_exception.UnauthenticatedException: <p>Lightsail throws this exception when the user has not been authenticated.</p>
        capo_lightsail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_lightsail.types.reset_distribution_cache_request.ResetDistributionCacheRequest]",
    ) -> OperationResponse[
        "capo_lightsail.types.reset_distribution_cache_result.ResetDistributionCacheResult"
    ]:
        import capo_lightsail._operations.lightsail_20161128.reset_distribution_cache

        output, http_response = (
            capo_lightsail._operations.lightsail_20161128.reset_distribution_cache.reset_distribution_cache(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ResetDistributionCache")
    )
    input_: capo_lightsail.types.reset_distribution_cache_request.ResetDistributionCacheRequest = {}
    if distribution_name is not None:
        input_["distribution_name"] = distribution_name

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