Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ImportWorkspaceMedia

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

Request Syntax


POST /workspaces/InstanceId/WorkspaceId/media HTTP/1.1
Content-type: application/json

{
   "MediaSource": "string",
   "MediaType": "string"
}

URI Request Parameters

The request uses the following URI parameters.

InstanceId

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

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: Yes

WorkspaceId

The identifier of the workspace.

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

Request Body

The request accepts the following data in JSON format.

MediaSource

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 533333.

Pattern: .*\\S.*

Required: Yes

MediaType

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

Type: String

Valid Values: IMAGE_LOGO_LIGHT_FAVICON | IMAGE_LOGO_DARK_FAVICON | IMAGE_LOGO_LIGHT_HORIZONTAL | IMAGE_LOGO_DARK_HORIZONTAL

Required: Yes

Response Syntax


HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceException

Request processing failed because of an error or failure with the service.

Message: The message.

HTTP Status Code: 500

InvalidParameterException

One or more of the specified parameters are not valid.

Message: The message about the parameters.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

Message: The message about the request.
Reason: Reason why the request was invalid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource was not found.

Message: The message about the resource.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429