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

Inherits:

Struct

• Object
• Struct
• Aws::FMS::Types::GetProtectionStatusRequest

Includes:

Structure

Defined in:

lib/aws-sdk-fms/types.rb

Overview

Note:

When making an API call, you may pass GetProtectionStatusRequest data as a 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:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ 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.

• #member_account_id ⇒ 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.

• #policy_id ⇒ 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.

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)

# File 'lib/aws-sdk-fms/types.rb', line 747

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

#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)

# File 'lib/aws-sdk-fms/types.rb', line 747

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

#member_account_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 747

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

#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)

# File 'lib/aws-sdk-fms/types.rb', line 747

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

#policy_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-fms/types.rb', line 747

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

#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)

# File 'lib/aws-sdk-fms/types.rb', line 747

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