GuardDuty / Client / get_malware_protection_plan

get_malware_protection_plan

GuardDuty.Client.get_malware_protection_plan(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.get_malware_protection_plan(
    MalwareProtectionPlanId='string'
)

Parameters:

MalwareProtectionPlanId (string) –

[REQUIRED]

A unique identifier associated with Malware Protection plan resource.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Role': 'string',
    'ProtectedResource': {
        'S3Bucket': {
            'BucketName': 'string',
            'ObjectPrefixes': [
                'string',
            ]
        }
    },
    'Actions': {
        'Tagging': {
            'Status': 'ENABLED'|'DISABLED'
        }
    },
    'CreatedAt': datetime(2015, 1, 1),
    'Status': 'ACTIVE'|'WARNING'|'ERROR',
    'StatusReasons': [
        {
            'Code': 'string',
            'Message': 'string'
        },
    ],
    'Tags': {
        'string': 'string'
    }
}

Response Structure

• (dict) –

  • Arn (string) –

    Amazon Resource Name (ARN) of the protected resource.

  • Role (string) –

    IAM role that includes the permissions required to scan and add tags to the associated protected resource.

  • ProtectedResource (dict) –

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

    • S3Bucket (dict) –

      Information about the protected S3 bucket resource.

      • BucketName (string) –

        Name of the S3 bucket.

      • ObjectPrefixes (list) –

        Information about the specified object prefixes. The S3 object will be scanned only if it belongs to any of the specified object prefixes.

        • (string) –

  • Actions (dict) –

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

    • Tagging (dict) –

      Indicates whether the scanned S3 object will have tags about the scan result.

      • Status (string) –

        Indicates whether or not the tags will added.

  • CreatedAt (datetime) –

    The timestamp when the Malware Protection plan resource was created.

  • Status (string) –

    Malware Protection plan status.

  • StatusReasons (list) –

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

    • (dict) –

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

      • Code (string) –

        Issue code.

      • Message (string) –

        Issue message that specifies the reason. For information about potential troubleshooting steps, see Troubleshooting Malware Protection for S3 status issues in the GuardDuty User Guide.

  • Tags (dict) –

    Tags added to the Malware Protection plan resource.

    • (string) –

      • (string) –

Exceptions

• GuardDuty.Client.exceptions.BadRequestException

• GuardDuty.Client.exceptions.AccessDeniedException

• GuardDuty.Client.exceptions.InternalServerErrorException

• GuardDuty.Client.exceptions.ResourceNotFoundException