Skip to content

GetProtectionStatusResponse

Source code in docs_src/capo_fms/types/get_protection_status_response.py
class GetProtectionStatusResponse(TypedDict, closed=True):
    admin_account_id: NotRequired["capo_fms.types.aws_account_id.AWSAccountId"]
    """<p>The ID of the Firewall Manager administrator account for this policy.</p>"""
    service_type: NotRequired[
        "capo_fms.types.security_service_type.SecurityServiceType"
    ]
    """<p>The service type that is protected by the policy. Currently, this is always <code>SHIELD_ADVANCED</code>.</p>"""
    data: NotRequired["capo_fms.types.protection_data.ProtectionData"]
    """<p>Details about the attack, including the following:</p> <ul> <li> <p>Attack type</p> </li> <li> <p>Account ID</p> </li> <li> <p>ARN of the resource attacked</p> </li> <li> <p>Start time of the attack</p> </li> <li> <p>End time of the attack (ongoing attacks will not have an end time)</p> </li> </ul> <p>The details are in JSON format. </p>"""
    next_token: NotRequired["capo_fms.types.pagination_token.PaginationToken"]
    """<p>If you have more objects than the number that you specified for <code>MaxResults</code> in the request, the response includes a <code>NextToken</code> value. To list more objects, submit another <code>GetProtectionStatus</code> request, and specify the <code>NextToken</code> value from the response in the <code>NextToken</code> value in the next request.</p> <p>Amazon Web Services SDKs provide auto-pagination that identify <code>NextToken</code> in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by <code>GetProtectionStatus</code>. You must submit subsequent requests with <code>NextToken</code> using your own processes. </p>"""

admin_account_id instance-attribute

admin_account_id: NotRequired[AWSAccountId]

The ID of the Firewall Manager administrator account for this policy.

data instance-attribute

data: NotRequired[ProtectionData]

Details about the attack, including the following:

  • Attack type

  • Account ID

  • ARN of the resource attacked

  • Start time of the attack

  • End time of the attack (ongoing attacks will not have an end time)

The details are in JSON format.

next_token instance-attribute

next_token: NotRequired[PaginationToken]

If you have more objects than the number that you specified for MaxResults in the request, the response includes a NextToken value. To list more objects, submit another GetProtectionStatus request, and specify the NextToken value from the response in the NextToken value in the next request.

Amazon Web Services SDKs provide auto-pagination that identify NextToken in a response and make subsequent request calls automatically on your behalf. However, this feature is not supported by GetProtectionStatus. You must submit subsequent requests with NextToken using your own processes.

service_type instance-attribute

service_type: NotRequired[SecurityServiceType]

The service type that is protected by the policy. Currently, this is always SHIELD_ADVANCED.