Api Gateway  >  Operations  >  create_resource

create_resource

Operation

create_resource async

create_resource(input: CreateResourceInput, plugins: list[Plugin] | None = None) -> CreateResourceOutput

Creates a Resource resource.

Parameters:

Name	Type	Description	Default
input	CreateResourceInput	An instance of CreateResourceInput.	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
CreateResourceOutput	An instance of CreateResourceOutput.

Input

CreateResourceInput dataclass

Requests API Gateway to create a Resource resource.

Attributes

parent_id class-attribute instance-attribute

parent_id: str | None = None

The parent resource's identifier.

path_part class-attribute instance-attribute

path_part: str | None = None

The last path segment for this resource.

rest_api_id class-attribute instance-attribute

rest_api_id: str | None = None

The string identifier of the associated RestApi.

Output

CreateResourceOutput 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.