GetMalwareProtectionPlan - Amazon GuardDuty

GetMalwareProtectionPlan

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

Request Syntax

GET /malware-protection-plan/malwareProtectionPlanId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

malwareProtectionPlanId

A unique identifier associated with Malware Protection plan resource.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "actions": { "tagging": { "status": "string" } }, "arn": "string", "createdAt": number, "protectedResource": { "s3Bucket": { "bucketName": "string", "objectPrefixes": [ "string" ] } }, "role": "string", "status": "string", "statusReasons": [ { "code": "string", "message": "string" } ], "tags": { "string" : "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

actions

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

Type: MalwareProtectionPlanActions object

arn

Amazon Resource Name (ARN) of the protected resource.

Type: String

createdAt

The timestamp when the Malware Protection plan resource was created.

Type: Timestamp

protectedResource

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

Type: CreateProtectedResource object

role

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

Type: String

status

Malware Protection plan status.

Type: String

Valid Values: ACTIVE | WARNING | ERROR

statusReasons

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

Type: Array of MalwareProtectionPlanStatusReason objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

tags

Tags added to the Malware Protection plan resource.

Type: String to string map

Map Entries: Maximum number of 200 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Value Length Constraints: Maximum length of 256.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

An access denied exception object.

HTTP Status Code: 403

BadRequestException

A bad request exception object.

HTTP Status Code: 400

InternalServerErrorException

An internal server error exception object.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: