Skip to content

API Gateway  >  Operations  >  update_resource

update_resource

Operation

update_resource async 

update_resource(input: UpdateResourceInput, plugins: list[Plugin] | None = None) -> UpdateResourceOutput

Changes information about a Resource resource.

Parameters:

Name Type Description Default
input UpdateResourceInput

An instance of UpdateResourceInput.

 required
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

Returns:

Type Description
UpdateResourceOutput

An instance of UpdateResourceOutput.

Input

UpdateResourceInput dataclass

Request to change information about a Resource resource.

Attributes

patch_operations class-attribute instance-attribute 
patch_operations: list[PatchOperation] | None = None

For more information about supported patch operations, see Patch Operations.

resource_id class-attribute instance-attribute 
resource_id: str | None = None

The identifier of the Resource resource.

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

The string identifier of the associated RestApi.

Output

UpdateResourceOutput dataclass

Represents an API resource.

Attributes

id class-attribute instance-attribute 
id: str | None = None

The resource's identifier.

parent_id class-attribute instance-attribute 
parent_id: str | None = None

The parent resource's identifier.

path class-attribute instance-attribute 
path: str | None = None

The full path for this resource.

path_part class-attribute instance-attribute 
path_part: str | None = None

The last path segment for this resource.

resource_methods class-attribute instance-attribute 
resource_methods: dict[str, Method] | None = None

Gets an API resource's method of a given HTTP verb.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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.