Skip to content

create_harness_endpoint

Operation

create_harness_endpoint

create_harness_endpoint(request: CreateHarnessEndpointInput | CreateHarnessEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateHarnessEndpointInputDict]) -> CreateHarnessEndpointOutput

Operation to create a harness endpoint.

Parameters:

Name Type Description Default
request CreateHarnessEndpointInput | CreateHarnessEndpointInputDict | 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[CreateHarnessEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateHarnessEndpointOutput

An instance of CreateHarnessEndpointOutput.

create_harness_endpoint async

create_harness_endpoint(request: CreateHarnessEndpointInput | CreateHarnessEndpointInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CreateHarnessEndpointInputDict]) -> CreateHarnessEndpointOutput

Operation to create a harness endpoint.

Parameters:

Name Type Description Default
request CreateHarnessEndpointInput | CreateHarnessEndpointInputDict | 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[CreateHarnessEndpointInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CreateHarnessEndpointOutput

An instance of CreateHarnessEndpointOutput.

Input

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

CreateHarnessEndpointInputDict

Bases: TypedDict

Dictionary form of CreateHarnessEndpointInput.

Attributes

client_token instance-attribute
client_token: str | None

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

description instance-attribute
description: str | None

A description of the endpoint.

endpoint_name instance-attribute
endpoint_name: Required[str]

The name of the endpoint. Must start with a letter and contain only alphanumeric characters and underscores.

harness_id instance-attribute
harness_id: Required[str]

The ID of the harness to create an endpoint for.

tags instance-attribute
tags: Mapping[str, str] | None

Tags to apply to the endpoint resource.

target_version instance-attribute
target_version: str | None

The harness version that the endpoint points to and serves invocations from.

CreateHarnessEndpointInput dataclass

Bases: _SerdeShape

Dataclass for CreateHarnessEndpointInput structure.

Attributes

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

A unique, case-sensitive identifier to ensure idempotency of the request.

This field is autopopulated if not provided.

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

A description of the endpoint.

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

The name of the endpoint. Must start with a letter and contain only alphanumeric characters and underscores.

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

The ID of the harness to create an endpoint for.

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

Tags to apply to the endpoint resource.

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

The harness version that the endpoint points to and serves invocations from.

Output

CreateHarnessEndpointOutput dataclass

Bases: _SerdeShape

Dataclass for CreateHarnessEndpointOutput structure.

Attributes

endpoint instance-attribute
endpoint: HarnessEndpoint

The endpoint that was created.

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.