Skip to content

Describe View

connect_describe_view R Documentation

Retrieves the view for the specified Amazon Connect instance and view identifier

Description

Retrieves the view for the specified Amazon Connect instance and view identifier.

The view identifier can be supplied as a ViewId or ARN.

⁠$SAVED⁠ needs to be supplied if a view is unpublished.

The view identifier can contain an optional qualifier, for example, ⁠<view-id>:$SAVED⁠, which is either an actual version number or an Amazon Connect managed qualifier ⁠$SAVED | $LATEST⁠. If it is not supplied, then ⁠$LATEST⁠ is assumed for customer managed views and an error is returned if there is no published content available. Version 1 is assumed for Amazon Web Services managed views.

Usage

connect_describe_view(InstanceId, ViewId)

Arguments

InstanceId

[required] The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

ViewId

[required] The ViewId of the view. This must be an ARN for Amazon Web Services managed views.

Value

A list with the following syntax: 

list(
  View = list(
    Id = "string",
    Arn = "string",
    Name = "string",
    Status = "PUBLISHED"|"SAVED",
    Type = "CUSTOMER_MANAGED"|"AWS_MANAGED",
    Description = "string",
    Version = 123,
    VersionDescription = "string",
    Content = list(
      InputSchema = "string",
      Template = "string",
      Actions = list(
        "string"
      )
    ),
    Tags = list(
      "string"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    ViewContentSha256 = "string"
  )
)

Request syntax

svc$describe_view(
  InstanceId = "string",
  ViewId = "string"
)