1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. connect
  5. getWorkspace

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.50.0 published on Monday, Jan 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.connect.getWorkspace

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.50.0 published on Monday, Jan 26, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Connect::Workspace

    Using getWorkspace

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getWorkspace(args: GetWorkspaceArgs, opts?: InvokeOptions): Promise<GetWorkspaceResult>
function getWorkspaceOutput(args: GetWorkspaceOutputArgs, opts?: InvokeOptions): Output<GetWorkspaceResult>
    def get_workspace(arn: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetWorkspaceResult
def get_workspace_output(arn: Optional[pulumi.Input[str]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkspaceResult]
    func LookupWorkspace(ctx *Context, args *LookupWorkspaceArgs, opts ...InvokeOption) (*LookupWorkspaceResult, error)
func LookupWorkspaceOutput(ctx *Context, args *LookupWorkspaceOutputArgs, opts ...InvokeOption) LookupWorkspaceResultOutput

    > Note: This function is named LookupWorkspace in the Go SDK.

    public static class GetWorkspace 
{
    public static Task<GetWorkspaceResult> InvokeAsync(GetWorkspaceArgs args, InvokeOptions? opts = null)
    public static Output<GetWorkspaceResult> Invoke(GetWorkspaceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)
public static Output<GetWorkspaceResult> getWorkspace(GetWorkspaceArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:connect:getWorkspace
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) for the workspace.
    Arn string
    The Amazon Resource Name (ARN) for the workspace.
    arn String
    The Amazon Resource Name (ARN) for the workspace.
    arn string
    The Amazon Resource Name (ARN) for the workspace.
    arn str
    The Amazon Resource Name (ARN) for the workspace.
    arn String
    The Amazon Resource Name (ARN) for the workspace.

    getWorkspace Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) for the workspace.
    Associations List<string>
    The resource ARNs associated with the workspace
    Description string
    The description of the workspace
    Id string
    The identifier of the workspace.
    Media List<Pulumi.AwsNative.Connect.Outputs.WorkspaceMediaItem>
    The media items for the workspace
    Name string
    The name of the workspace.
    Pages List<Pulumi.AwsNative.Connect.Outputs.WorkspacePage>
    The pages associated with the workspace
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    Theme Pulumi.AwsNative.Connect.Outputs.WorkspaceTheme
    The theme configuration for the workspace
    Title string
    The title of the workspace
    Visibility Pulumi.AwsNative.Connect.WorkspaceVisibility
    The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
    Arn string
    The Amazon Resource Name (ARN) for the workspace.
    Associations []string
    The resource ARNs associated with the workspace
    Description string
    The description of the workspace
    Id string
    The identifier of the workspace.
    Media []WorkspaceMediaItem
    The media items for the workspace
    Name string
    The name of the workspace.
    Pages []WorkspacePage
    The pages associated with the workspace
    Tags Tag
    An array of key-value pairs to apply to this resource.
    Theme WorkspaceTheme
    The theme configuration for the workspace
    Title string
    The title of the workspace
    Visibility WorkspaceVisibility
    The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
    arn String
    The Amazon Resource Name (ARN) for the workspace.
    associations List<String>
    The resource ARNs associated with the workspace
    description String
    The description of the workspace
    id String
    The identifier of the workspace.
    media List<WorkspaceMediaItem>
    The media items for the workspace
    name String
    The name of the workspace.
    pages List<WorkspacePage>
    The pages associated with the workspace
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    theme WorkspaceTheme
    The theme configuration for the workspace
    title String
    The title of the workspace
    visibility WorkspaceVisibility
    The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
    arn string
    The Amazon Resource Name (ARN) for the workspace.
    associations string[]
    The resource ARNs associated with the workspace
    description string
    The description of the workspace
    id string
    The identifier of the workspace.
    media WorkspaceMediaItem[]
    The media items for the workspace
    name string
    The name of the workspace.
    pages WorkspacePage[]
    The pages associated with the workspace
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    theme WorkspaceTheme
    The theme configuration for the workspace
    title string
    The title of the workspace
    visibility WorkspaceVisibility
    The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
    arn str
    The Amazon Resource Name (ARN) for the workspace.
    associations Sequence[str]
    The resource ARNs associated with the workspace
    description str
    The description of the workspace
    id str
    The identifier of the workspace.
    media Sequence[WorkspaceMediaItem]
    The media items for the workspace
    name str
    The name of the workspace.
    pages Sequence[WorkspacePage]
    The pages associated with the workspace
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    theme WorkspaceTheme
    The theme configuration for the workspace
    title str
    The title of the workspace
    visibility WorkspaceVisibility
    The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.
    arn String
    The Amazon Resource Name (ARN) for the workspace.
    associations List<String>
    The resource ARNs associated with the workspace
    description String
    The description of the workspace
    id String
    The identifier of the workspace.
    media List<Property Map>
    The media items for the workspace
    name String
    The name of the workspace.
    pages List<Property Map>
    The pages associated with the workspace
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.
    theme Property Map
    The theme configuration for the workspace
    title String
    The title of the workspace
    visibility "ALL" | "ASSIGNED" | "NONE"
    The visibility of the workspace. Will always be set to ASSIGNED oninitial creation.

    Supporting Types

    FontFamily

    Default Pulumi.AwsNative.Connect.WorkspaceFontFamily
    The default font family to use in the workspace theme.
    Default WorkspaceFontFamily
    The default font family to use in the workspace theme.
    default_ WorkspaceFontFamily
    The default font family to use in the workspace theme.
    default WorkspaceFontFamily
    The default font family to use in the workspace theme.
    default WorkspaceFontFamily
    The default font family to use in the workspace theme.

    Tag

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    WorkspaceFontFamily

    WorkspaceMediaItem

    Type Pulumi.AwsNative.Connect.WorkspaceMediaType
    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .
    Source string
    The source URL or data for the media asset.
    Type WorkspaceMediaType
    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .
    Source string
    The source URL or data for the media asset.
    type WorkspaceMediaType
    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .
    source String
    The source URL or data for the media asset.
    type WorkspaceMediaType
    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .
    source string
    The source URL or data for the media asset.
    type WorkspaceMediaType
    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .
    source str
    The source URL or data for the media asset.
    type "IMAGE_LOGO_LIGHT_FAVICON" | "IMAGE_LOGO_DARK_FAVICON" | "IMAGE_LOGO_LIGHT_HORIZONTAL" | "IMAGE_LOGO_DARK_HORIZONTAL"
    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL .
    source String
    The source URL or data for the media asset.

    WorkspaceMediaType

    WorkspacePage

    Page string
    The page identifier.
    ResourceArn string
    The Amazon Resource Name (ARN) of the resource associated with the page.
    InputData string
    The input data for the page.
    Slug string
    The slug for the page.
    Page string
    The page identifier.
    ResourceArn string
    The Amazon Resource Name (ARN) of the resource associated with the page.
    InputData string
    The input data for the page.
    Slug string
    The slug for the page.
    page String
    The page identifier.
    resourceArn String
    The Amazon Resource Name (ARN) of the resource associated with the page.
    inputData String
    The input data for the page.
    slug String
    The slug for the page.
    page string
    The page identifier.
    resourceArn string
    The Amazon Resource Name (ARN) of the resource associated with the page.
    inputData string
    The input data for the page.
    slug string
    The slug for the page.
    page str
    The page identifier.
    resource_arn str
    The Amazon Resource Name (ARN) of the resource associated with the page.
    input_data str
    The input data for the page.
    slug str
    The slug for the page.
    page String
    The page identifier.
    resourceArn String
    The Amazon Resource Name (ARN) of the resource associated with the page.
    inputData String
    The input data for the page.
    slug String
    The slug for the page.

    WorkspacePaletteCanvas

    ActiveBackground string
    The background color for active elements.
    ContainerBackground string
    The background color for container elements.
    PageBackground string
    The background color for page elements.
    ActiveBackground string
    The background color for active elements.
    ContainerBackground string
    The background color for container elements.
    PageBackground string
    The background color for page elements.
    activeBackground String
    The background color for active elements.
    containerBackground String
    The background color for container elements.
    pageBackground String
    The background color for page elements.
    activeBackground string
    The background color for active elements.
    containerBackground string
    The background color for container elements.
    pageBackground string
    The background color for page elements.
    active_background str
    The background color for active elements.
    container_background str
    The background color for container elements.
    page_background str
    The background color for page elements.
    activeBackground String
    The background color for active elements.
    containerBackground String
    The background color for container elements.
    pageBackground String
    The background color for page elements.

    WorkspacePaletteHeader

    Background string
    The background color of the header.
    InvertActionsColors bool
    Whether to invert the colors of action buttons in the header.
    Text string
    The text color in the header.
    TextHover string
    The text color when hovering over header elements.
    Background string
    The background color of the header.
    InvertActionsColors bool
    Whether to invert the colors of action buttons in the header.
    Text string
    The text color in the header.
    TextHover string
    The text color when hovering over header elements.
    background String
    The background color of the header.
    invertActionsColors Boolean
    Whether to invert the colors of action buttons in the header.
    text String
    The text color in the header.
    textHover String
    The text color when hovering over header elements.
    background string
    The background color of the header.
    invertActionsColors boolean
    Whether to invert the colors of action buttons in the header.
    text string
    The text color in the header.
    textHover string
    The text color when hovering over header elements.
    background str
    The background color of the header.
    invert_actions_colors bool
    Whether to invert the colors of action buttons in the header.
    text str
    The text color in the header.
    text_hover str
    The text color when hovering over header elements.
    background String
    The background color of the header.
    invertActionsColors Boolean
    Whether to invert the colors of action buttons in the header.
    text String
    The text color in the header.
    textHover String
    The text color when hovering over header elements.

    WorkspacePaletteNavigation

    Background string
    The background color of the navigation area.
    InvertActionsColors bool
    Whether to invert the colors of action buttons in the navigation area.
    Text string
    The text color in the navigation area.
    TextActive string
    The text color for active navigation items.
    TextBackgroundActive string
    The background color for active navigation items.
    TextBackgroundHover string
    The background color when hovering over navigation text.
    TextHover string
    The text color when hovering over navigation items.
    Background string
    The background color of the navigation area.
    InvertActionsColors bool
    Whether to invert the colors of action buttons in the navigation area.
    Text string
    The text color in the navigation area.
    TextActive string
    The text color for active navigation items.
    TextBackgroundActive string
    The background color for active navigation items.
    TextBackgroundHover string
    The background color when hovering over navigation text.
    TextHover string
    The text color when hovering over navigation items.
    background String
    The background color of the navigation area.
    invertActionsColors Boolean
    Whether to invert the colors of action buttons in the navigation area.
    text String
    The text color in the navigation area.
    textActive String
    The text color for active navigation items.
    textBackgroundActive String
    The background color for active navigation items.
    textBackgroundHover String
    The background color when hovering over navigation text.
    textHover String
    The text color when hovering over navigation items.
    background string
    The background color of the navigation area.
    invertActionsColors boolean
    Whether to invert the colors of action buttons in the navigation area.
    text string
    The text color in the navigation area.
    textActive string
    The text color for active navigation items.
    textBackgroundActive string
    The background color for active navigation items.
    textBackgroundHover string
    The background color when hovering over navigation text.
    textHover string
    The text color when hovering over navigation items.
    background str
    The background color of the navigation area.
    invert_actions_colors bool
    Whether to invert the colors of action buttons in the navigation area.
    text str
    The text color in the navigation area.
    text_active str
    The text color for active navigation items.
    text_background_active str
    The background color for active navigation items.
    text_background_hover str
    The background color when hovering over navigation text.
    text_hover str
    The text color when hovering over navigation items.
    background String
    The background color of the navigation area.
    invertActionsColors Boolean
    Whether to invert the colors of action buttons in the navigation area.
    text String
    The text color in the navigation area.
    textActive String
    The text color for active navigation items.
    textBackgroundActive String
    The background color for active navigation items.
    textBackgroundHover String
    The background color when hovering over navigation text.
    textHover String
    The text color when hovering over navigation items.

    WorkspacePalettePrimary

    Active string
    The primary color used for active states.
    ContrastText string
    The text color that contrasts with the primary color for readability.
    Default string
    The default primary color used throughout the workspace.
    Active string
    The primary color used for active states.
    ContrastText string
    The text color that contrasts with the primary color for readability.
    Default string
    The default primary color used throughout the workspace.
    active String
    The primary color used for active states.
    contrastText String
    The text color that contrasts with the primary color for readability.
    default_ String
    The default primary color used throughout the workspace.
    active string
    The primary color used for active states.
    contrastText string
    The text color that contrasts with the primary color for readability.
    default string
    The default primary color used throughout the workspace.
    active str
    The primary color used for active states.
    contrast_text str
    The text color that contrasts with the primary color for readability.
    default str
    The default primary color used throughout the workspace.
    active String
    The primary color used for active states.
    contrastText String
    The text color that contrasts with the primary color for readability.
    default String
    The default primary color used throughout the workspace.

    WorkspaceTheme

    Dark Pulumi.AwsNative.Connect.Inputs.WorkspaceThemeConfig
    The theme configuration for dark mode.
    Light Pulumi.AwsNative.Connect.Inputs.WorkspaceThemeConfig
    The theme configuration for light mode.
    Dark WorkspaceThemeConfig
    The theme configuration for dark mode.
    Light WorkspaceThemeConfig
    The theme configuration for light mode.
    dark WorkspaceThemeConfig
    The theme configuration for dark mode.
    light WorkspaceThemeConfig
    The theme configuration for light mode.
    dark WorkspaceThemeConfig
    The theme configuration for dark mode.
    light WorkspaceThemeConfig
    The theme configuration for light mode.
    dark WorkspaceThemeConfig
    The theme configuration for dark mode.
    light WorkspaceThemeConfig
    The theme configuration for light mode.
    dark Property Map
    The theme configuration for dark mode.
    light Property Map
    The theme configuration for light mode.

    WorkspaceThemeConfig

    Palette Pulumi.AwsNative.Connect.Inputs.WorkspaceThemePalette
    The color palette configuration for the workspace theme.
    Typography Pulumi.AwsNative.Connect.Inputs.WorkspaceThemeTypography
    The typography configuration for the workspace theme.
    Palette WorkspaceThemePalette
    The color palette configuration for the workspace theme.
    Typography WorkspaceThemeTypography
    The typography configuration for the workspace theme.
    palette WorkspaceThemePalette
    The color palette configuration for the workspace theme.
    typography WorkspaceThemeTypography
    The typography configuration for the workspace theme.
    palette WorkspaceThemePalette
    The color palette configuration for the workspace theme.
    typography WorkspaceThemeTypography
    The typography configuration for the workspace theme.
    palette WorkspaceThemePalette
    The color palette configuration for the workspace theme.
    typography WorkspaceThemeTypography
    The typography configuration for the workspace theme.
    palette Property Map
    The color palette configuration for the workspace theme.
    typography Property Map
    The typography configuration for the workspace theme.

    WorkspaceThemePalette

    Canvas Pulumi.AwsNative.Connect.Inputs.WorkspacePaletteCanvas
    The color configuration for the canvas area.
    Header Pulumi.AwsNative.Connect.Inputs.WorkspacePaletteHeader
    The color configuration for the header area.
    Navigation Pulumi.AwsNative.Connect.Inputs.WorkspacePaletteNavigation
    The color configuration for the navigation area.
    Primary Pulumi.AwsNative.Connect.Inputs.WorkspacePalettePrimary
    The primary color configuration used throughout the workspace.
    Canvas WorkspacePaletteCanvas
    The color configuration for the canvas area.
    Header WorkspacePaletteHeader
    The color configuration for the header area.
    Navigation WorkspacePaletteNavigation
    The color configuration for the navigation area.
    Primary WorkspacePalettePrimary
    The primary color configuration used throughout the workspace.
    canvas WorkspacePaletteCanvas
    The color configuration for the canvas area.
    header WorkspacePaletteHeader
    The color configuration for the header area.
    navigation WorkspacePaletteNavigation
    The color configuration for the navigation area.
    primary WorkspacePalettePrimary
    The primary color configuration used throughout the workspace.
    canvas WorkspacePaletteCanvas
    The color configuration for the canvas area.
    header WorkspacePaletteHeader
    The color configuration for the header area.
    navigation WorkspacePaletteNavigation
    The color configuration for the navigation area.
    primary WorkspacePalettePrimary
    The primary color configuration used throughout the workspace.
    canvas WorkspacePaletteCanvas
    The color configuration for the canvas area.
    header WorkspacePaletteHeader
    The color configuration for the header area.
    navigation WorkspacePaletteNavigation
    The color configuration for the navigation area.
    primary WorkspacePalettePrimary
    The primary color configuration used throughout the workspace.
    canvas Property Map
    The color configuration for the canvas area.
    header Property Map
    The color configuration for the header area.
    navigation Property Map
    The color configuration for the navigation area.
    primary Property Map
    The primary color configuration used throughout the workspace.

    WorkspaceThemeTypography

    FontFamily Pulumi.AwsNative.Connect.Inputs.FontFamily
    The font family configuration for text in the workspace.
    FontFamily FontFamily
    The font family configuration for text in the workspace.
    fontFamily FontFamily
    The font family configuration for text in the workspace.
    fontFamily FontFamily
    The font family configuration for text in the workspace.
    font_family FontFamily
    The font family configuration for text in the workspace.
    fontFamily Property Map
    The font family configuration for text in the workspace.

    WorkspaceVisibility

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.50.0 published on Monday, Jan 26, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate