Skip to main content
Version: 1.0 prerelease

SNSNotificationAction

class great_expectations.checkpoint.SNSNotificationAction(*, type: Literal['sns'] = 'sns', notify_on: Literal['all', 'failure', 'success'] = 'all', sns_topic_arn: str, sns_message_subject: Optional[str] = None)#

Action that pushes validations results to an SNS topic with a subject of passed or failed.

YAML configuration example:

    - name: send_sns_notification_on_validation_result
    action:
      class_name: SNSNotificationAction
      # put the actual SNS Arn in the uncommitted/config_variables.yml file
      # or pass in as environment variable
      sns_topic_arn:
      sns_subject:

Parameters:

  • sns_topic_arn – The SNS Arn to publish messages to.

  • sns_subject – Optional. The SNS Message Subject - defaults to expectation_suite_identifier.name.

run(validation_result_suite: ExpectationSuiteValidationResult, validation_result_suite_identifier: Union[ValidationResultIdentifier, GXCloudIdentifier], expectation_suite_identifier: Optional[ExpectationSuiteIdentifier] = None, checkpoint_identifier=None, **kwargs)#

Public entrypoint GX uses to trigger a ValidationAction.

When a ValidationAction is configured in a Checkpoint, this method gets called after the Checkpoint produces an ExpectationSuiteValidationResult.

Parameters:

  • validation_result_suite – An instance of the ExpectationSuiteValidationResult class.

  • validation_result_suite_identifier – an instance of either the ValidationResultIdentifier class (for open source Great Expectations) or the GXCloudIdentifier (from Great Expectations Cloud).

  • expectation_suite_identifier – Optionally, an instance of the ExpectationSuiteIdentifier class.

  • checkpoint_identifier – Optionally, an Identifier for the Checkpoint.

  • kwargs – named parameters that are specific to a given Action, and need to be assigned a value in the Action's configuration in a Checkpoint's action_list.

Returns:

A Dict describing the result of the Action.