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

CreateTopicV2

Creates a new Q topic.

Request Syntax


POST /accounts/AwsAccountId/topicsV2 HTTP/1.1
Content-type: application/json

{
   "CustomInstructions": { 
      "CustomInstructionsString": "string"
   },
   "FolderArns": [ "string" ],
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "Topic": { 
      "DataSetRelations": [ 
         { 
            "Left": { 
               "ColumnNames": [ "string" ],
               "DataSetArn": "string"
            },
            "Right": { 
               "ColumnNames": [ "string" ],
               "DataSetArn": "string"
            }
         }
      ],
      "DataSets": [ 
         { 
            "DataSetArn": "string",
            "DataSetName": "string"
         }
      ],
      "Description": "string",
      "Name": "string"
   },
   "TopicId": "string"
}

URI Request Parameters

The request uses the following URI parameters.

AwsAccountId

The ID of the AWS account that you want to create a topic in.

Length Constraints: Fixed length of 12.

Pattern: ^[0-9]{12}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

Topic

The definition of a topic to create.

Type: TopicV2Details object

Required: Yes

TopicId

The ID for the topic that you want to create. This ID is unique per AWS Region for each AWS account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[A-Za-z0-9-_.\\+]*$

Required: Yes

CustomInstructions

Instructions that provide additional guidance and context for response generation.

Type: CustomInstructions object

Required: No

FolderArns

The Amazon Resource Names (ARNs) of the folders that you want the topic to reside in.

Type: Array of strings

Array Members: Maximum number of 1 item.

Required: No

Tags

Contains a map of the key-value pairs for the resource tag or tags that are assigned to the topic.

Type: Array of Tag objects

Array Members: Minimum number of 1 item. Maximum number of 200 items.

Required: No

Response Syntax


HTTP/1.1 Status
Content-type: application/json

{
   "Arn": "string",
   "RequestId": "string",
   "TopicId": "string"
}

Response Elements

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

Status: The HTTP status of the request.

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

Arn

The Amazon Resource Name (ARN) of the topic.

Type: String

RequestId

The AWS request ID for this operation.

Type: String

TopicId

The ID for the topic that you want to create. This ID is unique per AWS Region for each AWS account.

Type: String

Length Constraints: Maximum length of 256.

Pattern: ^[A-Za-z0-9-_.\\+]*$

Errors

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

AccessDeniedException

You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon Quick Sight service, that your policies have the correct permissions, and that you are using the correct credentials.

RequestId: The AWS request ID for this request.

HTTP Status Code: 401

ConflictException

Updating or deleting a resource can cause an inconsistent state.

RequestId: The AWS request ID for this request.

HTTP Status Code: 409

InternalFailureException

An internal failure occurred.

RequestId: The AWS request ID for this request.

HTTP Status Code: 500

InvalidParameterValueException

One or more parameters has a value that isn't valid.

RequestId: The AWS request ID for this request.

HTTP Status Code: 400

LimitExceededException

A limit is exceeded.

RequestId: The AWS request ID for this request.
ResourceType: Limit exceeded.

HTTP Status Code: 409

ResourceExistsException

The resource specified already exists.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 409

ResourceNotFoundException

One or more resources can't be found.

RequestId: The AWS request ID for this request.
ResourceType: The resource type for this request.

HTTP Status Code: 404

ThrottlingException

Access is throttled.

RequestId: The AWS request ID for this request.

HTTP Status Code: 429

Examples

Example

This example illustrates one usage of CreateTopicV2.

Sample Request


POST /accounts/{AwsAccountId}/topicsV2 HTTP/1.1
Content-type: application/json