List Rules

connect_list_rules

R Documentation

List all rules for the specified Amazon Connect instance¶

Description¶

List all rules for the specified Amazon Connect instance.

Usage¶

connect_list_rules(InstanceId, PublishStatus, EventSourceName,
  MaxResults, NextToken)

Arguments¶

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

PublishStatus

The publish status of the rule.

EventSourceName

The name of the event source.

MaxResults

The maximum number of results to return per page.

NextToken

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

Value¶

A list with the following syntax:

list(
  RuleSummaryList = list(
    list(
      Name = "string",
      RuleId = "string",
      RuleArn = "string",
      EventSourceName = "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnRealTimeChatAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|"OnContactEvaluationSubmit"|"OnMetricDataUpdate"|"OnCaseCreate"|"OnCaseUpdate",
      PublishStatus = "DRAFT"|"PUBLISHED",
      ActionSummaries = list(
        list(
          ActionType = "CREATE_TASK"|"ASSIGN_CONTACT_CATEGORY"|"GENERATE_EVENTBRIDGE_EVENT"|"SEND_NOTIFICATION"|"CREATE_CASE"|"UPDATE_CASE"|"END_ASSOCIATED_TASKS"|"SUBMIT_AUTO_EVALUATION"
        )
      ),
      CreatedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastUpdatedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_rules(
  InstanceId = "string",
  PublishStatus = "DRAFT"|"PUBLISHED",
  EventSourceName = "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnRealTimeChatAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|"OnContactEvaluationSubmit"|"OnMetricDataUpdate"|"OnCaseCreate"|"OnCaseUpdate",
  MaxResults = 123,
  NextToken = "string"
)