Skip to content

import_workspace_media async

import_workspace_media(
    instance_id: InstanceId,
    workspace_id: WorkspaceId,
    media_type: MediaType,
    media_source: MediaSource,
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> ImportWorkspaceMediaResponse

Imports a media asset (such as a logo) for use in a workspace.

Parameters:

  • instance_id (InstanceId) –

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

  • workspace_id (WorkspaceId) –

    The identifier of the workspace.

  • media_type (MediaType) –

    The type of media. Valid values are: IMAGE_LOGO_FAVICON and IMAGE_LOGO_HORIZONTAL.

  • media_source (MediaSource) –

    The media source. Can be an S3 presigned URL or a base64-encoded string.

Raises:

Source code in docs_src/capo_connect/_services/async_connect.py
async def import_workspace_media(
    self,
    instance_id: "capo_connect.types.instance_id.InstanceId",
    workspace_id: "capo_connect.types.workspace_id.WorkspaceId",
    media_type: "capo_connect.types.media_type.MediaType",
    media_source: "capo_connect.types.media_source.MediaSource",
    *,
    config_overrides: Optional[AsyncConnectClientConfig] = None,
) -> "capo_connect.types.import_workspace_media_response.ImportWorkspaceMediaResponse":
    """<p>Imports a media asset (such as a logo) for use in a workspace.</p>

    Args:
        instance_id: <p>The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.</p>
        workspace_id: <p>The identifier of the workspace.</p>
        media_type: <p>The type of media. Valid values are: <code>IMAGE_LOGO_FAVICON</code> and <code>IMAGE_LOGO_HORIZONTAL</code>.</p>
        media_source: <p>The media source. Can be an S3 presigned URL or a base64-encoded string.</p>

    Raises:
        capo_connect.errors.internal_service_exception.InternalServiceException: <p>Request processing failed because of an error or failure with the service.</p>
        capo_connect.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the specified parameters are not valid.</p>
        capo_connect.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_connect.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource was not found.</p>
        capo_connect.errors.throttling_exception.ThrottlingException: <p>The throttling limit has been exceeded.</p>
        capo_connect.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_connect.types.import_workspace_media_request.ImportWorkspaceMediaRequest]",
    ) -> AsyncOperationResponse[
        "capo_connect.types.import_workspace_media_response.ImportWorkspaceMediaResponse"
    ]:
        import capo_connect._operations.amazon_connect_service.import_workspace_media

        (
            output,
            http_response,
        ) = await capo_connect._operations.amazon_connect_service.import_workspace_media.async_import_workspace_media(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ImportWorkspaceMedia")
    )
    input_: capo_connect.types.import_workspace_media_request.ImportWorkspaceMediaRequest = {
        "instance_id": instance_id,
        "workspace_id": workspace_id,
        "media_type": media_type,
        "media_source": media_source,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output