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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#end_timeTime

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 Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

Returns:

  • (Time)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1624

class GetProtectionStatusRequest < Struct.new(
  :policy_id,
  :member_account_id,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

Specifies the number of objects that you want 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)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1624

class GetProtectionStatusRequest < Struct.new(
  :policy_id,
  :member_account_id,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#member_account_idString

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

Returns:

  • (String)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1624

class GetProtectionStatusRequest < Struct.new(
  :policy_id,
  :member_account_id,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

If you specify a value for MaxResults and you have more objects than the number that you specify for MaxResults, 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)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1624

class GetProtectionStatusRequest < Struct.new(
  :policy_id,
  :member_account_id,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#policy_idString

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

Returns:

  • (String)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1624

class GetProtectionStatusRequest < Struct.new(
  :policy_id,
  :member_account_id,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end

#start_timeTime

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 Firewall Manager is Unix time in seconds. However, any valid timestamp format is allowed.

Returns:

  • (Time)


1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
# File 'gems/aws-sdk-fms/lib/aws-sdk-fms/types.rb', line 1624

class GetProtectionStatusRequest < Struct.new(
  :policy_id,
  :member_account_id,
  :start_time,
  :end_time,
  :next_token,
  :max_results)
  SENSITIVE = []
  include Aws::Structure
end