cancel_retention_update
Creates, updates, deletes, gets or lists a cancel_retention_update resource.
Overview
| Name | cancel_retention_update |
| Type | Resource |
| Id | sumologic.partitions.cancel_retention_update |
Fields
The following fields are returned by SELECT queries:
SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
cancelRetentionUpdate | exec | id, region | Cancel update to retention of a partition for which retention was updated previously using reduceRetentionPeriodImmediately parameter as false |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
id | string | Identifier of the partition to cancel the retention update for. (example: 1) |
region | string | SumoLogic region (enum: [us2, au, ca, de, eu, fed, in, jp], default: us2) |
Lifecycle Methods
- cancelRetentionUpdate
Cancel update to retention of a partition for which retention was updated previously using reduceRetentionPeriodImmediately parameter as false
EXEC sumologic.partitions.cancel_retention_update.cancelRetentionUpdate
@id='{{ id }}' --required,
@region='{{ region }}' --required
;