NetworkSecurityManagerCustomerAPI / Client / get_template

get_template

NetworkSecurityManagerCustomerAPI.Client.get_template(**kwargs)

Retrieves the details of the specified template.

See also: AWS API Documentation

Request Syntax

response = client.get_template(
    templateIdentifier='string'
)
Parameters:

templateIdentifier (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'templateId': 'string',
    'templateArn': 'string',
    'templateName': 'string',
    'templateDescription': 'string',
    'status': 'DRAFT'|'ACTIVE'|'DISABLED',
    'version': 'string',
    'associatedRuleList': [
        {
            'ruleArn': 'string'
        },
    ],
    'updateToken': 'string',
    'isSnapshot': True|False,
    'hasPublishedVersion': True|False,
    'firewallType': 'WAF',
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

  • (dict) –

    • templateId (string) –

      The service-generated id of the template.

    • templateArn (string) –

      The Amazon Resource Name (ARN) of the template.

    • templateName (string) –

      The name of the template.

    • templateDescription (string) –

      A description of the template.

    • status (string) –

      The current status of the resource: DRAFT (unpublished, editable) or ACTIVE (published, in use).

    • version (string) –

      The version of the resource.

    • associatedRuleList (list) –

      The rules associated with the template.

      • (dict) –

        An association between a template and a rule, as returned in outputs. The corresponding request structure is RuleReference.

        • ruleArn (string) –

          The ARN of the associated rule.

    • 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.

    • firewallType (string) –

      The firewall type associated with the resource.

    • updatedAt (datetime) –

      The time when the resource was last updated.

Exceptions