GetAssistant - Amazon Connect

GetAssistant

Retrieves information about an assistant.

Request Syntax

GET /assistants/assistantId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

assistantId

The identifier of the Amazon Q assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "assistant": { "assistantArn": "string", "assistantId": "string", "capabilityConfiguration": { "type": "string" }, "description": "string", "integrationConfiguration": { "topicIntegrationArn": "string" }, "name": "string", "serverSideEncryptionConfiguration": { "kmsKeyId": "string" }, "status": "string", "tags": { "string" : "string" }, "type": "string" } }

Response Elements

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

The following data is returned in JSON format by the service.

assistant

Information about the assistant.

Type: AssistantData object

Errors

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

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: