You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::FMS::Types::GetProtectionStatusRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing GetProtectionStatusRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  policy_id: "PolicyId", # required
  member_account_id: "AWSAccountId",
  start_time: Time.now,
  end_time: Time.now,
  next_token: "PaginationToken",
  max_results: 1,
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#end_time ⇒ Time

The end of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

Returns:

  • (Time) —

    The end of the time period to query for the attacks.

#max_results ⇒ Integer

Specifies the number of objects that you want AWS Firewall Manager to return for this request. If you have more objects than the number that you specify for MaxResults, the response includes a NextToken value that you can use to get another batch of objects.

Returns:

  • (Integer) —

    Specifies the number of objects that you want AWS Firewall Manager to return for this request.

#member_account_id ⇒ String

The AWS account that is in scope of the policy that you want to get the details for.

Returns:

  • (String) —

    The AWS account that is in scope of the policy that you want to get the details for.

#next_token ⇒ String

If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects. For the second and subsequent GetProtectionStatus requests, specify the value of NextToken from the previous response to get information about another batch of objects.

Returns:

  • (String) —

    If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, AWS Firewall Manager returns a NextToken value in the response, which you can use to retrieve another group of objects.

#policy_id ⇒ String

The ID of the policy for which you want to get the attack information.

Returns:

  • (String) —

    The ID of the policy for which you want to get the attack information.

#start_time ⇒ Time

The start of the time period to query for the attacks. This is a timestamp type. The request syntax listing indicates a number type because the default used by AWS Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

Returns:

  • (Time) —

    The start of the time period to query for the attacks.