Skip to content

Commit da832da

Browse files
Introduced custom instructions for topics.
1 parent be48f07 commit da832da

20 files changed

+386
-14
lines changed

generator/ServiceModels/quicksight/quicksight-2018-04-01.api.json

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7555,7 +7555,8 @@
75557555
"TopicId":{"shape":"TopicId"},
75567556
"Topic":{"shape":"TopicDetails"},
75577557
"Tags":{"shape":"TagList"},
7558-
"FolderArns":{"shape":"FolderArnList"}
7558+
"FolderArns":{"shape":"FolderArnList"},
7559+
"CustomInstructions":{"shape":"CustomInstructions"}
75597560
}
75607561
},
75617562
"CreateTopicResponse":{
@@ -7790,6 +7791,18 @@
77907791
"NullOption":{"shape":"FilterNullOption"}
77917792
}
77927793
},
7794+
"CustomInstructions":{
7795+
"type":"structure",
7796+
"required":["CustomInstructionsString"],
7797+
"members":{
7798+
"CustomInstructionsString":{"shape":"CustomInstructionsString"}
7799+
}
7800+
},
7801+
"CustomInstructionsString":{
7802+
"type":"string",
7803+
"max":5000,
7804+
"sensitive":true
7805+
},
77937806
"CustomLabel":{
77947807
"type":"string",
77957808
"max":2048,
@@ -11804,7 +11817,8 @@
1180411817
"Status":{
1180511818
"shape":"StatusCode",
1180611819
"location":"statusCode"
11807-
}
11820+
},
11821+
"CustomInstructions":{"shape":"CustomInstructions"}
1180811822
}
1180911823
},
1181011824
"DescribeUserRequest":{
@@ -24109,7 +24123,8 @@
2410924123
"location":"uri",
2411024124
"locationName":"TopicId"
2411124125
},
24112-
"Topic":{"shape":"TopicDetails"}
24126+
"Topic":{"shape":"TopicDetails"},
24127+
"CustomInstructions":{"shape":"CustomInstructions"}
2411324128
}
2411424129
},
2411524130
"UpdateTopicResponse":{

generator/ServiceModels/quicksight/quicksight-2018-04-01.docs.json

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
"ListIAMPolicyAssignments": "<p>Lists the IAM policy assignments in the current Amazon QuickSight account.</p>",
134134
"ListIAMPolicyAssignmentsForUser": "<p>Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.</p>",
135135
"ListIdentityPropagationConfigs": "<p>Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access.</p> <p>This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.</p>",
136-
"ListIngestions": "<p>Lists the history of SPICE ingestions for a dataset.</p>",
136+
"ListIngestions": "<p>Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.</p>",
137137
"ListNamespaces": "<p>Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.</p>",
138138
"ListRefreshSchedules": "<p>Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules. </p>",
139139
"ListRoleMemberships": "<p>Lists all groups that are associated with a role.</p>",
@@ -3526,6 +3526,20 @@
35263526
"CategoryFilterConfiguration$CustomFilterListConfiguration": "<p>A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.</p>"
35273527
}
35283528
},
3529+
"CustomInstructions": {
3530+
"base": "<p>Instructions that provide additional guidance and context for response generation.</p>",
3531+
"refs": {
3532+
"CreateTopicRequest$CustomInstructions": "<p>Custom instructions for the topic.</p>",
3533+
"DescribeTopicResponse$CustomInstructions": "<p>Custom instructions for the topic.</p>",
3534+
"UpdateTopicRequest$CustomInstructions": "<p>Custom instructions for the topic.</p>"
3535+
}
3536+
},
3537+
"CustomInstructionsString": {
3538+
"base": null,
3539+
"refs": {
3540+
"CustomInstructions$CustomInstructionsString": "<p>A text field for providing additional guidance or context for response generation.</p>"
3541+
}
3542+
},
35293543
"CustomLabel": {
35303544
"base": null,
35313545
"refs": {

generator/ServiceModels/quicksight/quicksight-2018-04-01.normal.json

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2481,7 +2481,7 @@
24812481
{"shape":"InvalidNextTokenException"},
24822482
{"shape":"InternalFailureException"}
24832483
],
2484-
"documentation":"<p>Lists the history of SPICE ingestions for a dataset.</p>"
2484+
"documentation":"<p>Lists the history of SPICE ingestions for a dataset. Limited to 5 TPS per user and 25 TPS per account.</p>"
24852485
},
24862486
"ListNamespaces":{
24872487
"name":"ListNamespaces",
@@ -10314,6 +10314,10 @@
1031410314
"FolderArns":{
1031510315
"shape":"FolderArnList",
1031610316
"documentation":"<p>The Folder ARN of the folder that you want the topic to reside in.</p>"
10317+
},
10318+
"CustomInstructions":{
10319+
"shape":"CustomInstructions",
10320+
"documentation":"<p>Custom instructions for the topic.</p>"
1031710321
}
1031810322
}
1031910323
},
@@ -10750,6 +10754,22 @@
1075010754
},
1075110755
"documentation":"<p>A list of custom filter values.</p>"
1075210756
},
10757+
"CustomInstructions":{
10758+
"type":"structure",
10759+
"required":["CustomInstructionsString"],
10760+
"members":{
10761+
"CustomInstructionsString":{
10762+
"shape":"CustomInstructionsString",
10763+
"documentation":"<p>A text field for providing additional guidance or context for response generation.</p>"
10764+
}
10765+
},
10766+
"documentation":"<p>Instructions that provide additional guidance and context for response generation.</p>"
10767+
},
10768+
"CustomInstructionsString":{
10769+
"type":"string",
10770+
"max":5000,
10771+
"sensitive":true
10772+
},
1075310773
"CustomLabel":{
1075410774
"type":"string",
1075510775
"max":2048,
@@ -16933,6 +16953,10 @@
1693316953
"shape":"StatusCode",
1693416954
"documentation":"<p>The HTTP status of the request.</p>",
1693516955
"location":"statusCode"
16956+
},
16957+
"CustomInstructions":{
16958+
"shape":"CustomInstructions",
16959+
"documentation":"<p>Custom instructions for the topic.</p>"
1693616960
}
1693716961
}
1693816962
},
@@ -37293,6 +37317,10 @@
3729337317
"Topic":{
3729437318
"shape":"TopicDetails",
3729537319
"documentation":"<p>The definition of the topic that you want to update.</p>"
37320+
},
37321+
"CustomInstructions":{
37322+
"shape":"CustomInstructions",
37323+
"documentation":"<p>Custom instructions for the topic.</p>"
3729637324
}
3729737325
}
3729837326
},

sdk/code-analysis/ServiceAnalysis/QuickSight/Generated/PropertyValueRules.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3828,6 +3828,10 @@
38283828
<max>2048</max>
38293829
<pattern>^[a-zA-Z0-9]+$</pattern>
38303830
</property-value-rule>
3831+
<property-value-rule>
3832+
<property>Amazon.QuickSight.Model.CustomInstructions.CustomInstructionsString</property>
3833+
<max>5000</max>
3834+
</property-value-rule>
38313835
<property-value-rule>
38323836
<property>Amazon.QuickSight.Model.CustomNarrativeOptions.Narrative</property>
38333837
<max>150000</max>

sdk/src/Services/QuickSight/Generated/Model/CreateTopicRequest.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ namespace Amazon.QuickSight.Model
3636
public partial class CreateTopicRequest : AmazonQuickSightRequest
3737
{
3838
private string _awsAccountId;
39+
private CustomInstructions _customInstructions;
3940
private List<string> _folderArns = AWSConfigs.InitializeCollections ? new List<string>() : null;
4041
private List<Tag> _tags = AWSConfigs.InitializeCollections ? new List<Tag>() : null;
4142
private TopicDetails _topic;
@@ -60,6 +61,24 @@ internal bool IsSetAwsAccountId()
6061
return this._awsAccountId != null;
6162
}
6263

64+
/// <summary>
65+
/// Gets and sets the property CustomInstructions.
66+
/// <para>
67+
/// Custom instructions for the topic.
68+
/// </para>
69+
/// </summary>
70+
public CustomInstructions CustomInstructions
71+
{
72+
get { return this._customInstructions; }
73+
set { this._customInstructions = value; }
74+
}
75+
76+
// Check to see if CustomInstructions property is set
77+
internal bool IsSetCustomInstructions()
78+
{
79+
return this._customInstructions != null;
80+
}
81+
6382
/// <summary>
6483
/// Gets and sets the property FolderArns.
6584
/// <para>
Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
/*
17+
* Do not modify this file. This file is generated from the quicksight-2018-04-01.normal.json service model.
18+
*/
19+
using System;
20+
using System.Collections.Generic;
21+
using System.Xml.Serialization;
22+
using System.Text;
23+
using System.IO;
24+
using System.Net;
25+
26+
using Amazon.Runtime;
27+
using Amazon.Runtime.Internal;
28+
29+
#pragma warning disable CS0612,CS0618,CS1570
30+
namespace Amazon.QuickSight.Model
31+
{
32+
/// <summary>
33+
/// Instructions that provide additional guidance and context for response generation.
34+
/// </summary>
35+
public partial class CustomInstructions
36+
{
37+
private string _customInstructionsString;
38+
39+
/// <summary>
40+
/// Gets and sets the property CustomInstructionsString.
41+
/// <para>
42+
/// A text field for providing additional guidance or context for response generation.
43+
/// </para>
44+
/// </summary>
45+
[AWSProperty(Required=true, Sensitive=true, Max=5000)]
46+
public string CustomInstructionsString
47+
{
48+
get { return this._customInstructionsString; }
49+
set { this._customInstructionsString = value; }
50+
}
51+
52+
// Check to see if CustomInstructionsString property is set
53+
internal bool IsSetCustomInstructionsString()
54+
{
55+
return this._customInstructionsString != null;
56+
}
57+
58+
}
59+
}

sdk/src/Services/QuickSight/Generated/Model/DescribeTopicResponse.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ namespace Amazon.QuickSight.Model
3535
public partial class DescribeTopicResponse : AmazonWebServiceResponse
3636
{
3737
private string _arn;
38+
private CustomInstructions _customInstructions;
3839
private string _requestId;
3940
private int? _status;
4041
private TopicDetails _topic;
@@ -58,6 +59,24 @@ internal bool IsSetArn()
5859
return this._arn != null;
5960
}
6061

62+
/// <summary>
63+
/// Gets and sets the property CustomInstructions.
64+
/// <para>
65+
/// Custom instructions for the topic.
66+
/// </para>
67+
/// </summary>
68+
public CustomInstructions CustomInstructions
69+
{
70+
get { return this._customInstructions; }
71+
set { this._customInstructions = value; }
72+
}
73+
74+
// Check to see if CustomInstructions property is set
75+
internal bool IsSetCustomInstructions()
76+
{
77+
return this._customInstructions != null;
78+
}
79+
6180
/// <summary>
6281
/// Gets and sets the property RequestId.
6382
/// <para>

sdk/src/Services/QuickSight/Generated/Model/Internal/MarshallTransformations/CreateTopicRequestMarshaller.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ public IRequest Marshall(CreateTopicRequest publicRequest)
7070
writer.Validate = false;
7171
writer.WriteObjectStart();
7272
var context = new JsonMarshallerContext(request, writer);
73+
if(publicRequest.IsSetCustomInstructions())
74+
{
75+
context.Writer.WritePropertyName("CustomInstructions");
76+
context.Writer.WriteObjectStart();
77+
78+
var marshaller = CustomInstructionsMarshaller.Instance;
79+
marshaller.Marshall(publicRequest.CustomInstructions, context);
80+
81+
context.Writer.WriteObjectEnd();
82+
}
83+
7384
if(publicRequest.IsSetFolderArns())
7485
{
7586
context.Writer.WritePropertyName("FolderArns");
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
/*
2+
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License").
5+
* You may not use this file except in compliance with the License.
6+
* A copy of the License is located at
7+
*
8+
* http://aws.amazon.com/apache2.0
9+
*
10+
* or in the "license" file accompanying this file. This file is distributed
11+
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
12+
* express or implied. See the License for the specific language governing
13+
* permissions and limitations under the License.
14+
*/
15+
16+
/*
17+
* Do not modify this file. This file is generated from the quicksight-2018-04-01.normal.json service model.
18+
*/
19+
using System;
20+
using System.Collections.Generic;
21+
using System.Globalization;
22+
using System.IO;
23+
using System.Text;
24+
using System.Xml.Serialization;
25+
26+
using Amazon.QuickSight.Model;
27+
using Amazon.Runtime;
28+
using Amazon.Runtime.Internal;
29+
using Amazon.Runtime.Internal.Transform;
30+
using Amazon.Runtime.Internal.Util;
31+
using ThirdParty.Json.LitJson;
32+
33+
#pragma warning disable CS0612,CS0618
34+
namespace Amazon.QuickSight.Model.Internal.MarshallTransformations
35+
{
36+
/// <summary>
37+
/// CustomInstructions Marshaller
38+
/// </summary>
39+
public class CustomInstructionsMarshaller : IRequestMarshaller<CustomInstructions, JsonMarshallerContext>
40+
{
41+
/// <summary>
42+
/// Unmarshaller the response from the service to the response class.
43+
/// </summary>
44+
/// <param name="requestObject"></param>
45+
/// <param name="context"></param>
46+
/// <returns></returns>
47+
public void Marshall(CustomInstructions requestObject, JsonMarshallerContext context)
48+
{
49+
if(requestObject == null)
50+
return;
51+
if(requestObject.IsSetCustomInstructionsString())
52+
{
53+
context.Writer.WritePropertyName("CustomInstructionsString");
54+
context.Writer.Write(requestObject.CustomInstructionsString);
55+
}
56+
57+
}
58+
59+
/// <summary>
60+
/// Singleton Marshaller.
61+
/// </summary>
62+
public readonly static CustomInstructionsMarshaller Instance = new CustomInstructionsMarshaller();
63+
64+
}
65+
}

0 commit comments

Comments
 (0)