Skip to content

create_resource

Operation

create_resource

create_resource(request: CreateResourceInput | CreateResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateResourceInputDict]) -> CreateResourceOutput

Creates a Resource resource.

Parameters:

Name Type Description Default
request CreateResourceInput | CreateResourceInputDict | 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[CreateResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateResourceOutput

An instance of CreateResourceOutput.

create_resource async

create_resource(request: CreateResourceInput | CreateResourceInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateResourceInputDict]) -> CreateResourceOutput

Creates a Resource resource.

Parameters:

Name Type Description Default
request CreateResourceInput | CreateResourceInputDict | 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[CreateResourceInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateResourceOutput

An instance of CreateResourceOutput.

Input

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

CreateResourceInputDict

Bases: TypedDict

Dictionary form of CreateResourceInput.

Attributes

parent_id instance-attribute
parent_id: Required[str]

The parent resource's identifier.

path_part instance-attribute
path_part: Required[str]

The last path segment for this resource.

rest_api_id instance-attribute
rest_api_id: Required[str]

The string identifier of the associated RestApi.

CreateResourceInput dataclass

Bases: _SerdeShape

Requests API Gateway to create a Resource resource.

Attributes

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

The parent resource's identifier.

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

The last path segment for this resource.

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

The string identifier of the associated RestApi.

Output

CreateResourceOutput dataclass

Bases: _SerdeShape

Represents an API resource.

Attributes

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

The resource's identifier.

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

The parent resource's identifier.

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

The full path for this resource.

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

The last path segment for this resource.

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

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

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.