Skip to content

get_trusted_entity_set

Operation

get_trusted_entity_set

get_trusted_entity_set(request: GetTrustedEntitySetInput | GetTrustedEntitySetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTrustedEntitySetInputDict]) -> GetTrustedEntitySetOutput

Retrieves the trusted entity set associated with the specified trustedEntitySetId.

Parameters:

Name Type Description Default
request GetTrustedEntitySetInput | GetTrustedEntitySetInputDict | 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[GetTrustedEntitySetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTrustedEntitySetOutput

An instance of GetTrustedEntitySetOutput.

get_trusted_entity_set async

get_trusted_entity_set(request: GetTrustedEntitySetInput | GetTrustedEntitySetInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetTrustedEntitySetInputDict]) -> GetTrustedEntitySetOutput

Retrieves the trusted entity set associated with the specified trustedEntitySetId.

Parameters:

Name Type Description Default
request GetTrustedEntitySetInput | GetTrustedEntitySetInputDict | 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[GetTrustedEntitySetInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetTrustedEntitySetOutput

An instance of GetTrustedEntitySetOutput.

Input

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

GetTrustedEntitySetInputDict

Bases: TypedDict

Dictionary form of GetTrustedEntitySetInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the GuardDuty detector associated with this trusted entity set.

trusted_entity_set_id instance-attribute
trusted_entity_set_id: Required[str]

The unique ID that helps GuardDuty identify the trusted entity set.

GetTrustedEntitySetInput dataclass

Bases: _SerdeShape

Dataclass for GetTrustedEntitySetInput structure.

Attributes

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

The unique ID of the GuardDuty detector associated with this trusted entity set.

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

The unique ID that helps GuardDuty identify the trusted entity set.

Output

GetTrustedEntitySetOutput dataclass

Bases: _SerdeShape

Dataclass for GetTrustedEntitySetOutput structure.

Attributes

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The timestamp when the associated trusted entity set was created.

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

The error details when the status is shown as ERROR.

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

The Amazon Web Services account ID that owns the Amazon S3 bucket specified in the location parameter.

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

The format of the file that contains the trusted entity set.

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

The URI of the file that contains the trusted entity set.

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

The name of the threat entity set associated with the specified trustedEntitySetId.

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.

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

The status of the associated trusted entity set.

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

The tags associated with trusted entity set resource.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The timestamp when the associated trusted entity set was updated.