Skip to content

get_trail

Operation

get_trail

get_trail(request: GetTrailInput | GetTrailInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTrailInputDict]) -> GetTrailOutput

Returns settings information for a specified trail.

Parameters:

Name Type Description Default
request GetTrailInput | GetTrailInputDict | 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[GetTrailInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTrailOutput

An instance of GetTrailOutput.

get_trail async

get_trail(request: GetTrailInput | GetTrailInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTrailInputDict]) -> GetTrailOutput

Returns settings information for a specified trail.

Parameters:

Name Type Description Default
request GetTrailInput | GetTrailInputDict | 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[GetTrailInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTrailOutput

An instance of GetTrailOutput.

Input

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

GetTrailInputDict

Bases: TypedDict

Dictionary form of GetTrailInput.

Attributes

name instance-attribute
name: Required[str]

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.

GetTrailInput dataclass

Bases: _SerdeShape

Dataclass for GetTrailInput structure.

Attributes

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

The name or the Amazon Resource Name (ARN) of the trail for which you want to retrieve settings information.

Output

GetTrailOutput dataclass

Bases: _SerdeShape

Dataclass for GetTrailOutput 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.

trail class-attribute instance-attribute
trail: Trail | None = ...

The settings for a trail.