Skip to content

get_malware_protection_plan

Operation

get_malware_protection_plan

get_malware_protection_plan(request: GetMalwareProtectionPlanInput | GetMalwareProtectionPlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMalwareProtectionPlanInputDict]) -> GetMalwareProtectionPlanOutput

Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.

Parameters:

Name Type Description Default
request GetMalwareProtectionPlanInput | GetMalwareProtectionPlanInputDict | 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[GetMalwareProtectionPlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMalwareProtectionPlanOutput

An instance of GetMalwareProtectionPlanOutput.

get_malware_protection_plan async

get_malware_protection_plan(request: GetMalwareProtectionPlanInput | GetMalwareProtectionPlanInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetMalwareProtectionPlanInputDict]) -> GetMalwareProtectionPlanOutput

Retrieves the Malware Protection plan details associated with a Malware Protection plan ID.

Parameters:

Name Type Description Default
request GetMalwareProtectionPlanInput | GetMalwareProtectionPlanInputDict | 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[GetMalwareProtectionPlanInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetMalwareProtectionPlanOutput

An instance of GetMalwareProtectionPlanOutput.

Input

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

GetMalwareProtectionPlanInputDict

Bases: TypedDict

Dictionary form of GetMalwareProtectionPlanInput.

Attributes

malware_protection_plan_id instance-attribute
malware_protection_plan_id: Required[str]

A unique identifier associated with Malware Protection plan resource.

GetMalwareProtectionPlanInput dataclass

Bases: _SerdeShape

Dataclass for GetMalwareProtectionPlanInput structure.

Attributes

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

A unique identifier associated with Malware Protection plan resource.

Output

GetMalwareProtectionPlanOutput dataclass

Bases: _SerdeShape

Dataclass for GetMalwareProtectionPlanOutput structure.

Attributes

actions class-attribute instance-attribute
actions: MalwareProtectionPlanActions | None = ...

Information about whether the tags will be added to the S3 object after scanning.

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

Amazon Resource Name (ARN) of the protected resource.

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

The timestamp when the Malware Protection plan resource was created.

protected_resource class-attribute instance-attribute
protected_resource: CreateProtectedResource | None = ...

Information about the protected resource that is associated with the created Malware Protection plan. Presently, S3Bucket is the only supported protected resource.

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.

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

Amazon Resource Name (ARN) of the IAM role that includes the permissions to scan and add tags to the associated protected resource.

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

Malware Protection plan status.

status_reasons class-attribute instance-attribute
status_reasons: list[MalwareProtectionPlanStatusReason] | None = ...

Information about the issue code and message associated to the status of your Malware Protection plan.

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

Tags added to the Malware Protection plan resource.