Connect / Client / list_workspace_media

list_workspace_media

Connect.Client.list_workspace_media(**kwargs)

Lists media assets (such as logos) associated with a workspace.

See also: AWS API Documentation

Request Syntax

response = client.list_workspace_media(
    InstanceId='string',
    WorkspaceId='string'
)
Parameters:

  • InstanceId (string) –

    [REQUIRED]

    The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

  • WorkspaceId (string) –

    [REQUIRED]

    The identifier of the workspace.

Return type:

dict

Returns:

Response Syntax

{
    'Media': [
        {
            'Type': 'IMAGE_LOGO_LIGHT_FAVICON'|'IMAGE_LOGO_DARK_FAVICON'|'IMAGE_LOGO_LIGHT_HORIZONTAL'|'IMAGE_LOGO_DARK_HORIZONTAL',
            'Source': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • Media (list) –

      A list of media assets for the workspace.

      • (dict) –

        Contains information about a media asset used in a workspace.

        • Type (string) –

          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.

Exceptions