Describe Rule

connect_describe_rule

R Documentation

Describes a rule for the specified Amazon Connect instance

Description

Describes a rule for the specified Amazon Connect instance.

Usage

connect_describe_rule(InstanceId, RuleId)

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.

RuleId

[required] A unique identifier for the rule.

Value

A list with the following syntax:

list(
  Rule = list(
    Name = "string",
    RuleId = "string",
    RuleArn = "string",
    TriggerEventSource = list(
      EventSourceName = "OnPostCallAnalysisAvailable"|"OnRealTimeCallAnalysisAvailable"|"OnRealTimeChatAnalysisAvailable"|"OnPostChatAnalysisAvailable"|"OnZendeskTicketCreate"|"OnZendeskTicketStatusUpdate"|"OnSalesforceCaseCreate"|"OnContactEvaluationSubmit"|"OnMetricDataUpdate"|"OnCaseCreate"|"OnCaseUpdate",
      IntegrationAssociationId = "string"
    ),
    Function = "string",
    Actions = list(
      list(
        ActionType = "CREATE_TASK"|"ASSIGN_CONTACT_CATEGORY"|"GENERATE_EVENTBRIDGE_EVENT"|"SEND_NOTIFICATION"|"CREATE_CASE"|"UPDATE_CASE"|"END_ASSOCIATED_TASKS"|"SUBMIT_AUTO_EVALUATION",
        TaskAction = list(
          Name = "string",
          Description = "string",
          ContactFlowId = "string",
          References = list(
            list(
              Value = "string",
              Type = "URL"|"ATTACHMENT"|"NUMBER"|"STRING"|"DATE"|"EMAIL"
            )
          )
        ),
        EventBridgeAction = list(
          Name = "string"
        ),
        AssignContactCategoryAction = list(),
        SendNotificationAction = list(
          DeliveryMethod = "EMAIL",
          Subject = "string",
          Content = "string",
          ContentType = "PLAIN_TEXT",
          Recipient = list(
            UserTags = list(
              "string"
            ),
            UserIds = list(
              "string"
            )
          )
        ),
        CreateCaseAction = list(
          Fields = list(
            list(
              Id = "string",
              Value = list(
                BooleanValue = TRUE|FALSE,
                DoubleValue = 123.0,
                EmptyValue = list(),
                StringValue = "string"
              )
            )
          ),
          TemplateId = "string"
        ),
        UpdateCaseAction = list(
          Fields = list(
            list(
              Id = "string",
              Value = list(
                BooleanValue = TRUE|FALSE,
                DoubleValue = 123.0,
                EmptyValue = list(),
                StringValue = "string"
              )
            )
          )
        ),
        EndAssociatedTasksAction = list(),
        SubmitAutoEvaluationAction = list(
          EvaluationFormId = "string"
        )
      )
    ),
    PublishStatus = "DRAFT"|"PUBLISHED",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedBy = "string",
    Tags = list(
      "string"
    )
  )
)

Request syntax

svc$describe_rule(
  InstanceId = "string",
  RuleId = "string"
)