NetworkSecurityManagerCustomerAPI / Client / update_template

update_template¶

NetworkSecurityManagerCustomerAPI.Client.update_template(**kwargs)¶

Updates the specified template. To prevent conflicting concurrent updates, provide the current updateToken. Use isPublished to publish the update or keep the template as a draft.

Request Syntax

response = client.update_template(
    templateIdentifier='string',
    updateToken='string',
    templateDescription='string',
    associatedRuleList=[
        {
            'ruleIdentifier': 'string'
        },
    ],
    isPublished=True|False,
    clientToken='string'
)

Parameters:

templateIdentifier (string) –
[REQUIRED]

The identifier of the template. This is the template’s Amazon Resource Name (ARN).
updateToken (string) –
[REQUIRED]

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.
templateDescription (string) – A description of the template.
associatedRuleList (list) –
The rules associated with the template.
- (dict) –
  
  A reference to a rule in a create or update request.
  - ruleIdentifier (string) – [REQUIRED]
    
    The identifier of the rule. This is the rule’s Amazon Resource Name (ARN).
isPublished (boolean) –
[REQUIRED]

Specifies whether to publish the resource. When true, the resource is saved in published ( ACTIVE) state. When false, it is saved as a draft ( DRAFT).
clientToken (string) –
A unique, case-sensitive token that you provide to ensure that the operation completes no more than one time. If you retry a request with the same client token and the same parameters, the service returns the result of the original successful request.

This field is autopopulated if not provided.

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

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