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.40.0 published on Thursday, Dec 11, 2025 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.40.0 published on Thursday, Dec 11, 2025 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

    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

    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

    WorkspacePaletteHeader

    background String
    invertActionsColors Boolean
    text String
    textHover String
    background string
    invertActionsColors boolean
    text string
    textHover string
    background String
    invertActionsColors Boolean
    text String
    textHover String

    WorkspacePaletteNavigation

    WorkspacePalettePrimary

    Active string
    ContrastText string
    Default string
    Active string
    ContrastText string
    Default string
    active String
    contrastText String
    default_ String
    active string
    contrastText string
    default string
    active String
    contrastText String
    default String

    WorkspaceTheme

    WorkspaceThemeConfig

    WorkspaceThemePalette

    WorkspaceThemeTypography

    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.40.0 published on Thursday, Dec 11, 2025 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native
      Meet Neo: Your AI Platform Teammate