Skip to content

flush_stage_cache

Operation

flush_stage_cache

flush_stage_cache(request: FlushStageCacheInput | FlushStageCacheInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[FlushStageCacheInputDict]) -> FlushStageCacheOutput

Flushes a stage's cache.

Parameters:

Name Type Description Default
request FlushStageCacheInput | FlushStageCacheInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[FlushStageCacheInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
FlushStageCacheOutput

An instance of FlushStageCacheOutput.

flush_stage_cache async

flush_stage_cache(request: FlushStageCacheInput | FlushStageCacheInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[FlushStageCacheInputDict]) -> FlushStageCacheOutput

Flushes a stage's cache.

Parameters:

Name Type Description Default
request FlushStageCacheInput | FlushStageCacheInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[FlushStageCacheInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
FlushStageCacheOutput

An instance of FlushStageCacheOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

FlushStageCacheInputDict

Bases: TypedDict

Dictionary form of FlushStageCacheInput.

Attributes

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

stage_name instance-attribute
stage_name: Required[str]

The name of the stage to flush its cache.

FlushStageCacheInput dataclass

Bases: _SerdeShape

Requests API Gateway to flush a stage's cache.

Attributes

rest_api_id class-attribute instance-attribute
rest_api_id: str | None = ...

The string identifier of the associated RestApi.

stage_name class-attribute instance-attribute
stage_name: str | None = ...

The name of the stage to flush its cache.

Output

FlushStageCacheOutput dataclass

Bases: _SerdeShape

Dataclass for FlushStageCacheOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.