Skip to content

Updates the layout used to view data for a specific domain

Description

Updates the layout used to view data for a specific domain. This API can only be invoked from the Amazon Connect admin website.

Usage

customerprofiles_update_domain_layout(DomainName, LayoutDefinitionName,
  Description, DisplayName, IsDefault, LayoutType, Layout)

Arguments

  • DomainName

    [required] The unique name of the domain.

  • LayoutDefinitionName

    [required] The unique name of the layout.

  • Description

    The description of the layout

  • DisplayName

    The display name of the layout

  • IsDefault

    If set to true for a layout, this layout will be used by default to view data. If set to false, then the layout will not be used by default, but it can be used to view data by explicitly selecting it in the console.

  • LayoutType

    The type of layout that can be used to view data under a Customer Profiles domain.

  • Layout

    A customizable layout that can be used to view data under a Customer Profiles domain.

Value

A list with the following syntax:

list(
  LayoutDefinitionName = "string",
  Description = "string",
  DisplayName = "string",
  IsDefault = TRUE|FALSE,
  LayoutType = "PROFILE_EXPLORER",
  Layout = "string",
  Version = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$update_domain_layout(
  DomainName = "string",
  LayoutDefinitionName = "string",
  Description = "string",
  DisplayName = "string",
  IsDefault = TRUE|FALSE,
  LayoutType = "PROFILE_EXPLORER",
  Layout = "string"
)