Skip to contents

Creates or updates a field index policy for the specified log group. Only log groups in the Standard log class support field index policies. For more information about log classes, see Log classes.

See https://www.paws-r-sdk.com/docs/cloudwatchlogs_put_index_policy/ for full documentation.

Usage

cloudwatchlogs_put_index_policy(logGroupIdentifier, policyDocument)

Arguments

logGroupIdentifier

[required] Specify either the log group name or log group ARN to apply this field index policy to. If you specify an ARN, use the format arn:aws:logs:region:account-id:log-group:log_group_name Don't include an * at the end.

policyDocument

[required] The index policy document, in JSON format. The following is an example of an index policy document that creates indexes with different types.

"policyDocument": "{"Fields": [ "TransactionId" ], "FieldsV2": {"RequestId": {"type": "FIELD_INDEX"}, "APIName": {"type": "FACET"}, "StatusCode": {"type": "FACET"}}}"

You can use FieldsV2 to specify the type for each field. Supported types are FIELD_INDEX and FACET. Field names within Fields and FieldsV2 must be mutually exclusive.

The policy document must include at least one field index. For more information about the fields that can be included and other restrictions, see Field index syntax and quotas.