Skip to content

Commit 6a2bb6d

Browse files
Improve descriptions for various API commands and data types.
1 parent d7208e5 commit 6a2bb6d

34 files changed

+339
-322
lines changed

generator/ServiceModels/opensearch/opensearch-2021-01-01.docs.json

Lines changed: 89 additions & 89 deletions
Large diffs are not rendered by default.

generator/ServiceModels/opensearch/opensearch-2021-01-01.normal.json

Lines changed: 89 additions & 89 deletions
Large diffs are not rendered by default.

sdk/src/Services/OpenSearchService/Generated/Model/AppConfig.cs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,9 @@
3030
namespace Amazon.OpenSearchService.Model
3131
{
3232
/// <summary>
33-
/// Configurations of the OpenSearch Application.
33+
/// Configuration settings for an OpenSearch application. For more information, see see
34+
/// <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using
35+
/// the OpenSearch user interface in Amazon OpenSearch Service</a>.
3436
/// </summary>
3537
public partial class AppConfig
3638
{
@@ -40,7 +42,7 @@ public partial class AppConfig
4042
/// <summary>
4143
/// Gets and sets the property Key.
4244
/// <para>
43-
/// Specify the item to configure, such as admin role for the OpenSearch Application.
45+
/// The configuration item to set, such as the admin role for the OpenSearch application.
4446
/// </para>
4547
/// </summary>
4648
public AppConfigType Key
@@ -58,7 +60,7 @@ internal bool IsSetKey()
5860
/// <summary>
5961
/// Gets and sets the property Value.
6062
/// <para>
61-
/// Specifies the value to configure for the key, such as an IAM user ARN.
63+
/// The value assigned to the configuration key, such as an IAM user ARN.
6264
/// </para>
6365
/// </summary>
6466
[AWSProperty(Min=1, Max=4096)]

sdk/src/Services/OpenSearchService/Generated/Model/ApplicationSummary.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
namespace Amazon.OpenSearchService.Model
3131
{
3232
/// <summary>
33-
/// Basic information of the OpenSearch Application.
33+
/// Basic details of an OpenSearch application.
3434
/// </summary>
3535
public partial class ApplicationSummary
3636
{
@@ -61,7 +61,7 @@ internal bool IsSetArn()
6161
/// <summary>
6262
/// Gets and sets the property CreatedAt.
6363
/// <para>
64-
/// Timestamp at which an OpenSearch Application was created.
64+
/// The timestamp when an OpenSearch application was created.
6565
/// </para>
6666
/// </summary>
6767
public DateTime CreatedAt
@@ -79,7 +79,7 @@ internal bool IsSetCreatedAt()
7979
/// <summary>
8080
/// Gets and sets the property Endpoint.
8181
/// <para>
82-
/// Endpoint URL of an OpenSearch Application.
82+
/// The endpoint URL of an OpenSearch application.
8383
/// </para>
8484
/// </summary>
8585
public string Endpoint
@@ -97,7 +97,7 @@ internal bool IsSetEndpoint()
9797
/// <summary>
9898
/// Gets and sets the property Id.
9999
/// <para>
100-
/// Unique identifier for an OpenSearch application.
100+
/// The unique identifier of an OpenSearch application.
101101
/// </para>
102102
/// </summary>
103103
public string Id
@@ -115,7 +115,7 @@ internal bool IsSetId()
115115
/// <summary>
116116
/// Gets and sets the property LastUpdatedAt.
117117
/// <para>
118-
/// Timestamp at which an OpenSearch Application was last updated.
118+
/// The timestamp of the last update to an OpenSearch application.
119119
/// </para>
120120
/// </summary>
121121
public DateTime LastUpdatedAt
@@ -133,7 +133,7 @@ internal bool IsSetLastUpdatedAt()
133133
/// <summary>
134134
/// Gets and sets the property Name.
135135
/// <para>
136-
/// Name of an OpenSearch Application.
136+
/// The name of an OpenSearch application.
137137
/// </para>
138138
/// </summary>
139139
[AWSProperty(Min=3, Max=30)]
@@ -152,8 +152,8 @@ internal bool IsSetName()
152152
/// <summary>
153153
/// Gets and sets the property Status.
154154
/// <para>
155-
/// Status of an OpenSearch Application. Possible values are <c>CREATING</c>, <c>UPDATING</c>,<c>
156-
/// DELETING</c>, <c>FAILED</c>, <c>ACTIVE</c>, and <c>DELETED</c>.
155+
/// The current status of an OpenSearch application. Possible values: <c>CREATING</c>,
156+
/// <c>UPDATING</c>, <c>DELETING</c>, <c>FAILED</c>, <c>ACTIVE</c>, and <c>DELETED</c>.
157157
/// </para>
158158
/// </summary>
159159
public ApplicationStatus Status

sdk/src/Services/OpenSearchService/Generated/Model/CreateApplicationRequest.cs

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,8 @@ namespace Amazon.OpenSearchService.Model
3131
{
3232
/// <summary>
3333
/// Container for the parameters to the CreateApplication operation.
34-
/// Creates an OpenSearch Application.
34+
/// Creates an OpenSearch UI application. For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/application.html">Using
35+
/// the OpenSearch user interface in Amazon OpenSearch Service</a>.
3536
/// </summary>
3637
public partial class CreateApplicationRequest : AmazonOpenSearchServiceRequest
3738
{
@@ -45,7 +46,7 @@ public partial class CreateApplicationRequest : AmazonOpenSearchServiceRequest
4546
/// <summary>
4647
/// Gets and sets the property AppConfigs.
4748
/// <para>
48-
/// Configurations of the OpenSearch Application, inlcuding admin configuration.
49+
/// Configuration settings for the OpenSearch application, including administrative options.
4950
/// </para>
5051
/// </summary>
5152
[AWSProperty(Max=200)]
@@ -64,7 +65,7 @@ internal bool IsSetAppConfigs()
6465
/// <summary>
6566
/// Gets and sets the property ClientToken.
6667
/// <para>
67-
/// A unique client idempotency token. It will be auto generated if not provided.
68+
/// Unique, case-sensitive identifier to ensure idempotency of the request.
6869
/// </para>
6970
/// </summary>
7071
[AWSProperty(Min=1, Max=64)]
@@ -83,7 +84,7 @@ internal bool IsSetClientToken()
8384
/// <summary>
8485
/// Gets and sets the property DataSources.
8586
/// <para>
86-
/// Data sources to be associated with the OpenSearch Application.
87+
/// The data sources to link to the OpenSearch application.
8788
/// </para>
8889
/// </summary>
8990
public List<DataSource> DataSources
@@ -101,7 +102,8 @@ internal bool IsSetDataSources()
101102
/// <summary>
102103
/// Gets and sets the property IamIdentityCenterOptions.
103104
/// <para>
104-
/// Settings of IAM Identity Center for the OpenSearch Application.
105+
/// Configuration settings for integrating Amazon Web Services IAM Identity Center with
106+
/// the OpenSearch application.
105107
/// </para>
106108
/// </summary>
107109
public IamIdentityCenterOptionsInput IamIdentityCenterOptions
@@ -119,8 +121,8 @@ internal bool IsSetIamIdentityCenterOptions()
119121
/// <summary>
120122
/// Gets and sets the property Name.
121123
/// <para>
122-
/// Name of the OpenSearch Appication to create. Application names are unique across the
123-
/// applications owned by an account within an Amazon Web Services Region.
124+
/// The unique name of the OpenSearch application. Names must be unique within an Amazon
125+
/// Web Services Region for each account.
124126
/// </para>
125127
/// </summary>
126128
[AWSProperty(Required=true, Min=3, Max=30)]

sdk/src/Services/OpenSearchService/Generated/Model/CreateApplicationResponse.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public partial class CreateApplicationResponse : AmazonWebServiceResponse
4646
/// <summary>
4747
/// Gets and sets the property AppConfigs.
4848
/// <para>
49-
/// Configurations of the OpenSearch Application, inlcuding admin configuration.
49+
/// Configuration settings for the OpenSearch application, including administrative options.
5050
/// </para>
5151
/// </summary>
5252
[AWSProperty(Max=200)]
@@ -81,7 +81,7 @@ internal bool IsSetArn()
8181
/// <summary>
8282
/// Gets and sets the property CreatedAt.
8383
/// <para>
84-
/// Timestamp when the OpenSearch Application was created.
84+
/// The timestamp indicating when the OpenSearch application was created.
8585
/// </para>
8686
/// </summary>
8787
public DateTime CreatedAt
@@ -99,7 +99,7 @@ internal bool IsSetCreatedAt()
9999
/// <summary>
100100
/// Gets and sets the property DataSources.
101101
/// <para>
102-
/// Data sources associated with the created OpenSearch Application.
102+
/// The data sources linked to the OpenSearch application.
103103
/// </para>
104104
/// </summary>
105105
public List<DataSource> DataSources
@@ -117,7 +117,7 @@ internal bool IsSetDataSources()
117117
/// <summary>
118118
/// Gets and sets the property IamIdentityCenterOptions.
119119
/// <para>
120-
/// Settings of IAM Identity Center for the created OpenSearch Application.
120+
/// The IAM Identity Center settings configured for the OpenSearch application.
121121
/// </para>
122122
/// </summary>
123123
public IamIdentityCenterOptions IamIdentityCenterOptions
@@ -135,7 +135,7 @@ internal bool IsSetIamIdentityCenterOptions()
135135
/// <summary>
136136
/// Gets and sets the property Id.
137137
/// <para>
138-
/// Unique identifier for the created OpenSearch Application.
138+
/// The unique identifier assigned to the OpenSearch application.
139139
/// </para>
140140
/// </summary>
141141
public string Id
@@ -153,7 +153,7 @@ internal bool IsSetId()
153153
/// <summary>
154154
/// Gets and sets the property Name.
155155
/// <para>
156-
/// Name of the created OpenSearch Application.
156+
/// The name of the OpenSearch application.
157157
/// </para>
158158
/// </summary>
159159
[AWSProperty(Min=3, Max=30)]

sdk/src/Services/OpenSearchService/Generated/Model/CreateDomainRequest.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -323,7 +323,8 @@ internal bool IsSetEngineVersion()
323323
/// <summary>
324324
/// Gets and sets the property IdentityCenterOptions.
325325
/// <para>
326-
/// Options for IAM Identity Center Option control for the domain.
326+
/// Configuration options for enabling and managing IAM Identity Center integration within
327+
/// a domain.
327328
/// </para>
328329
/// </summary>
329330
public IdentityCenterOptionsInput IdentityCenterOptions

sdk/src/Services/OpenSearchService/Generated/Model/DeleteApplicationRequest.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ namespace Amazon.OpenSearchService.Model
3131
{
3232
/// <summary>
3333
/// Container for the parameters to the DeleteApplication operation.
34-
/// Deletes an existing OpenSearch Application.
34+
/// Deletes a specified OpenSearch application.
3535
/// </summary>
3636
public partial class DeleteApplicationRequest : AmazonOpenSearchServiceRequest
3737
{
@@ -40,7 +40,7 @@ public partial class DeleteApplicationRequest : AmazonOpenSearchServiceRequest
4040
/// <summary>
4141
/// Gets and sets the property Id.
4242
/// <para>
43-
/// Unique identifier for the OpenSearch Application that you want to delete.
43+
/// The unique identifier of the OpenSearch application to delete.
4444
/// </para>
4545
/// </summary>
4646
[AWSProperty(Required=true)]

sdk/src/Services/OpenSearchService/Generated/Model/DomainConfig.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -278,7 +278,8 @@ internal bool IsSetEngineVersion()
278278
/// <summary>
279279
/// Gets and sets the property IdentityCenterOptions.
280280
/// <para>
281-
/// Container for IAM Identity Center Option control for the domain.
281+
/// Configuration options for enabling and managing IAM Identity Center integration within
282+
/// a domain.
282283
/// </para>
283284
/// </summary>
284285
public IdentityCenterOptionsStatus IdentityCenterOptions

sdk/src/Services/OpenSearchService/Generated/Model/DomainNodesStatus.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ internal bool IsSetNodeStatus()
120120
/// <summary>
121121
/// Gets and sets the property NodeType.
122122
/// <para>
123-
/// Indicates whether the nodes is a data, master, or ultrawarm node.
123+
/// Indicates whether the nodes is a data, master, or UltraWarm node.
124124
/// </para>
125125
/// </summary>
126126
public NodeType NodeType
@@ -174,7 +174,7 @@ internal bool IsSetStorageType()
174174
/// <summary>
175175
/// Gets and sets the property StorageVolumeType.
176176
/// <para>
177-
/// If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable
177+
/// If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable
178178
/// for data nodes.
179179
/// </para>
180180
/// </summary>

0 commit comments

Comments
 (0)