NetworkSecurityManagerCustomerAPI / Client / get_rule

get_rule¶

NetworkSecurityManagerCustomerAPI.Client.get_rule(**kwargs)¶

Retrieves the details of the specified rule.

Request Syntax

response = client.get_rule(
    ruleIdentifier='string'
)

Parameters:

ruleIdentifier (string) –

[REQUIRED]

The identifier of the rule. This is the rule’s Amazon Resource Name (ARN).

Return type:

dict

Returns:

Response Syntax

{
    'ruleId': 'string',
    'ruleArn': 'string',
    'ruleName': 'string',
    'firewallType': 'WAF',
    'ruleType': 'CONFIGURATION'|'INSPECTION',
    'ruleDescription': 'string',
    'configuration': {...}|[...]|123|123.4|'string'|True|None,
    'status': 'DRAFT'|'ACTIVE'|'DISABLED',
    'version': 'string',
    'updateToken': 'string',
    'isSnapshot': True|False,
    'hasPublishedVersion': True|False,
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- ruleId (string) –
  
  The service-generated id of the rule.
- ruleArn (string) –
  
  The Amazon Resource Name (ARN) of the rule.
- ruleName (string) –
  
  The name of the rule.
- firewallType (string) –
  
  The firewall type associated with the resource.
- ruleType (string) –
  
  The type of the rule. CONFIGURATION rules contain firewall settings, and INSPECTION rules contain rule groups.
- ruleDescription (string) –
  
  A description of the rule.
- configuration (document) –
  
  The firewall configuration for the rule, as a JSON document. The structure depends on the rule’s firewall type and rule type.
- status (string) –
  
  The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).
- version (string) –
  
  The version of the resource.
- updateToken (string) –
  
  A token used for optimistic concurrency control. Each read and write returns an updateToken. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.
- isSnapshot (boolean) –
  
  Specifies whether the resource is a snapshot of a published version.
- hasPublishedVersion (boolean) –
  
  Specifies whether a published version of the resource exists.
- updatedAt (datetime) –
  
  The time when the resource was last updated.

Exceptions

NetworkSecurityManagerCustomerAPI.Client.exceptions.ValidationException
NetworkSecurityManagerCustomerAPI.Client.exceptions.InternalServerException
NetworkSecurityManagerCustomerAPI.Client.exceptions.AccessDeniedException
NetworkSecurityManagerCustomerAPI.Client.exceptions.ResourceNotFoundException
NetworkSecurityManagerCustomerAPI.Client.exceptions.ThrottlingException