connect_describe_quick_connect: This API is in preview release for Amazon Connect and is...

Description Usage Arguments Value Request syntax

View source: R/connect_operations.R

Description

This API is in preview release for Amazon Connect and is subject to change.

Describes the quick connect.

Usage

1
connect_describe_quick_connect(InstanceId, QuickConnectId)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance.

QuickConnectId

[required] The identifier for the quick connect.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
list(
  QuickConnect = list(
    QuickConnectARN = "string",
    QuickConnectId = "string",
    Name = "string",
    Description = "string",
    QuickConnectConfig = list(
      QuickConnectType = "USER"|"QUEUE"|"PHONE_NUMBER",
      UserConfig = list(
        UserId = "string",
        ContactFlowId = "string"
      ),
      QueueConfig = list(
        QueueId = "string",
        ContactFlowId = "string"
      ),
      PhoneConfig = list(
        PhoneNumber = "string"
      )
    ),
    Tags = list(
      "string"
    )
  )
)

Request syntax

1
2
3
4
svc$describe_quick_connect(
  InstanceId = "string",
  QuickConnectId = "string"
)

paws.customer.engagement documentation built on Aug. 23, 2021, 9:22 a.m.