Skip to content

Commit 2d3d45e

Browse files
aws-sdk-dotnet-automationaws-sdk-dotnet-automation
committed
Documentation updates for Amazon GameLift Streams to address formatting errors, correct resource ID examples, and update links to other guides
1 parent 0343d11 commit 2d3d45e

File tree

48 files changed

+811
-634
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+811
-634
lines changed

‎generator/ServiceModels/gameliftstreams/gameliftstreams-2018-05-10.docs.json

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

‎generator/ServiceModels/gameliftstreams/gameliftstreams-2018-05-10.normal.json

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

‎sdk/src/Services/GameLiftStreams/Generated/Model/AddStreamGroupLocationsRequest.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,10 @@ public partial class AddStreamGroupLocationsRequest : AmazonGameLiftStreamsReque
5656
/// </para>
5757
///
5858
/// <para>
59-
/// This value is a Amazon Resource Name (ARN) that uniquely identifies the stream group
60-
/// resource. Format example: <c>sg-1AB2C3De4</c>.
59+
/// This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
60+
/// Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource.
61+
/// Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>.
62+
/// Example ID: <c>sg-1AB2C3De4</c>.
6163
/// </para>
6264
/// </summary>
6365
[AWSProperty(Required=true, Min=1, Max=128)]

‎sdk/src/Services/GameLiftStreams/Generated/Model/AddStreamGroupLocationsResponse.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ public partial class AddStreamGroupLocationsResponse : AmazonWebServiceResponse
4040
/// <summary>
4141
/// Gets and sets the property Identifier.
4242
/// <para>
43-
/// This value is the Amazon Resource Name (ARN) that uniquely identifies the stream group
44-
/// resource. Format example: <c>sg-1AB2C3De4</c>.
43+
/// This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
44+
/// Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource.
45+
/// Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>.
46+
/// Example ID: <c>sg-1AB2C3De4</c>.
4547
/// </para>
4648
/// </summary>
4749
[AWSProperty(Required=true, Min=1, Max=128)]

‎sdk/src/Services/GameLiftStreams/Generated/Model/ApplicationSummary.cs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,10 +106,8 @@ internal bool IsSetDescription()
106106
/// <summary>
107107
/// Gets and sets the property Id.
108108
/// <para>
109-
/// An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
110-
/// Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format
111-
/// example: ARN-<c>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</c>
112-
/// or ID-<c>a-9ZY8X7Wv6</c>.
109+
/// An ID that uniquely identifies the application resource. Example ID: <c>a-9ZY8X7Wv6</c>.
110+
///
113111
/// </para>
114112
/// </summary>
115113
[AWSProperty(Min=1, Max=32)]

‎sdk/src/Services/GameLiftStreams/Generated/Model/AssociateApplicationsRequest.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ public partial class AssociateApplicationsRequest : AmazonGameLiftStreamsRequest
4949
///
5050
/// <para>
5151
/// This value is a set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
52-
/// Resource Names (ARN)</a> or IDs that uniquely identify application resources. Format
53-
/// example: ARN-<c>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</c>
54-
/// or ID-<c>a-9ZY8X7Wv6</c>.
52+
/// Resource Names (ARN)</a> or IDs that uniquely identify application resources. Example
53+
/// ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>.
54+
/// Example ID: <c>a-9ZY8X7Wv6</c>.
5555
/// </para>
5656
/// </summary>
5757
[AWSProperty(Required=true, Min=1, Max=50)]
@@ -74,10 +74,10 @@ internal bool IsSetApplicationIdentifiers()
7474
/// </para>
7575
///
7676
/// <para>
77-
/// This value is a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
77+
/// This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
7878
/// Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource.
79-
/// Format example: ARN-<c>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</c>
80-
/// or ID-<c>sg-1AB2C3De4</c>.
79+
/// Example ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>.
80+
/// Example ID: <c>sg-1AB2C3De4</c>.
8181
/// </para>
8282
/// </summary>
8383
[AWSProperty(Required=true, Min=1, Max=128)]

‎sdk/src/Services/GameLiftStreams/Generated/Model/AssociateApplicationsResponse.cs

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,9 @@ public partial class AssociateApplicationsResponse : AmazonWebServiceResponse
4444
/// </para>
4545
///
4646
/// <para>
47-
/// This value is a set of either <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
48-
/// Resource Names (ARN)</a> or IDs that uniquely identify application resources. Format
49-
/// example: ARN-<c>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</c>
50-
/// or ID-<c>a-9ZY8X7Wv6</c>.
47+
/// This value is a set of <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
48+
/// Resource Names (ARNs)</a> that uniquely identify application resources. Example ARN:
49+
/// <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>.
5150
/// </para>
5251
/// </summary>
5352
public List<string> ApplicationArns
@@ -69,10 +68,10 @@ internal bool IsSetApplicationArns()
6968
/// </para>
7069
///
7170
/// <para>
72-
/// This value is a <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
73-
/// Resource Name (ARN)</a> or ID that uniquely identifies the stream group resource.
74-
/// Format example: ARN-<c>arn:aws:gameliftstreams:us-west-2:123456789012:streamgroup/sg-1AB2C3De4</c>
75-
/// or ID-<c>sg-1AB2C3De4</c>.
71+
/// This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
72+
/// Resource Name (ARN)</a> that uniquely identifies the stream group resource. Example
73+
/// ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:streamgroup/sg-1AB2C3De4</c>.
74+
///
7675
/// </para>
7776
/// </summary>
7877
[AWSProperty(Min=1, Max=128)]

‎sdk/src/Services/GameLiftStreams/Generated/Model/CreateApplicationRequest.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ namespace Amazon.GameLiftStreams.Model
4444
/// <important>
4545
/// <para>
4646
/// Make sure that your files in the Amazon S3 bucket are the correct version you want
47-
/// to use. As soon as you create a Amazon GameLift Streams application, you cannot change
48-
/// the files at a later time.
47+
/// to use. If you change the files at a later time, you will need to create a new Amazon
48+
/// GameLift Streams application.
4949
/// </para>
5050
/// </important>
5151
/// <para>
@@ -76,8 +76,8 @@ public partial class CreateApplicationRequest : AmazonGameLiftStreamsRequest
7676
/// <note>
7777
/// <para>
7878
/// The log bucket must have permissions that give Amazon GameLift Streams access to write
79-
/// the log files. For more information, see <b>Getting Started</b> in the Amazon GameLift
80-
/// Streams Developer Guide.
79+
/// the log files. For more information, see <a href="https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/applications.html#application-bucket-permission-template">Application
80+
/// log bucket permission policy</a> in the <i>Amazon GameLift Streams Developer Guide</i>.
8181
/// </para>
8282
/// </note>
8383
/// </summary>

‎sdk/src/Services/GameLiftStreams/Generated/Model/CreateApplicationResponse.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,9 @@ internal bool IsSetApplicationSourceUri()
113113
/// <summary>
114114
/// Gets and sets the property Arn.
115115
/// <para>
116-
/// An Amazon Resource Name (ARN) that's assigned to an application resource and uniquely
117-
/// identifies it across all Amazon Web Services Regions. Format is <c>arn:aws:gameliftstreams:[AWS
116+
/// The <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
117+
/// Resource Name (ARN)</a> that's assigned to an application resource and uniquely identifies
118+
/// it across all Amazon Web Services Regions. Format is <c>arn:aws:gameliftstreams:[AWS
118119
/// Region]:[AWS account]:application/[resource ID]</c>.
119120
/// </para>
120121
/// </summary>
@@ -210,10 +211,8 @@ internal bool IsSetExecutablePath()
210211
/// <summary>
211212
/// Gets and sets the property Id.
212213
/// <para>
213-
/// An <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
214-
/// Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Format
215-
/// example: ARN-<c>arn:aws:gameliftstreams:us-west-2:123456789012:application/a-9ZY8X7Wv6</c>
216-
/// or ID-<c>a-9ZY8X7Wv6</c>.
214+
/// A unique ID value that is assigned to the resource when it's created. Format example:
215+
/// <c>a-9ZY8X7Wv6</c>.
217216
/// </para>
218217
/// </summary>
219218
[AWSProperty(Min=1, Max=32)]

‎sdk/src/Services/GameLiftStreams/Generated/Model/CreateStreamGroupRequest.cs

Lines changed: 31 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -44,26 +44,35 @@ namespace Amazon.GameLiftStreams.Model
4444
/// <para>
4545
/// Stream capacity represents the number of concurrent streams that can be active at
4646
/// a time. You set stream capacity per location, per stream group. There are two types
47-
/// of capacity: always-on and on-demand:
47+
/// of capacity, always-on and on-demand:
4848
/// </para>
4949
/// <ul> <li>
5050
/// <para>
5151
/// <b>Always-on</b>: The streaming capacity that is allocated and ready to handle stream
5252
/// requests without delay. You pay for this capacity whether it's in use or not. Best
53-
/// for quickest time from streaming request to streaming session. <pre><c> &lt;/p&gt;
54-
/// &lt;/li&gt; &lt;li&gt; &lt;p&gt; &lt;b&gt;On-demand&lt;/b&gt;: The streaming capacity
55-
/// that Amazon GameLift Streams can allocate in response to stream requests, and then
56-
/// de-allocate when the session has terminated. This offers a cost control measure at
57-
/// the expense of a greater startup time (typically under 5 minutes). &lt;/p&gt; &lt;/li&gt;
58-
/// &lt;/ul&gt; &lt;p&gt; To adjust the capacity of any &lt;code&gt;ACTIVE&lt;/code&gt;
59-
/// stream group, call &lt;a href=&quot;https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html&quot;&gt;UpdateStreamGroup&lt;/a&gt;.
60-
/// &lt;/p&gt; &lt;p&gt; If the request is successful, Amazon GameLift Streams begins
61-
/// creating the stream group. Amazon GameLift Streams assigns a unique ID to the stream
62-
/// group resource and sets the status to &lt;code&gt;ACTIVATING&lt;/code&gt;. When the
63-
/// stream group reaches &lt;code&gt;ACTIVE&lt;/code&gt; status, you can start stream
64-
/// sessions by using &lt;a href=&quot;https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html&quot;&gt;StartStreamSession&lt;/a&gt;.
65-
/// To check the stream group's status, call &lt;a href=&quot;https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html&quot;&gt;GetStreamGroup&lt;/a&gt;.
66-
/// &lt;/p&gt; </c></pre>
53+
/// for quickest time from streaming request to streaming session.
54+
/// </para>
55+
/// </li> <li>
56+
/// <para>
57+
/// <b>On-demand</b>: The streaming capacity that Amazon GameLift Streams can allocate
58+
/// in response to stream requests, and then de-allocate when the session has terminated.
59+
/// This offers a cost control measure at the expense of a greater startup time (typically
60+
/// under 5 minutes).
61+
/// </para>
62+
/// </li> </ul>
63+
/// <para>
64+
/// To adjust the capacity of any <c>ACTIVE</c> stream group, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_UpdateStreamGroup.html">UpdateStreamGroup</a>.
65+
///
66+
/// </para>
67+
///
68+
/// <para>
69+
/// If the request is successful, Amazon GameLift Streams begins creating the stream
70+
/// group. Amazon GameLift Streams assigns a unique ID to the stream group resource and
71+
/// sets the status to <c>ACTIVATING</c>. When the stream group reaches <c>ACTIVE</c>
72+
/// status, you can start stream sessions by using <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_StartStreamSession.html">StartStreamSession</a>.
73+
/// To check the stream group's status, call <a href="https://docs.aws.amazon.com/gameliftstreams/latest/apireference/API_GetStreamGroup.html">GetStreamGroup</a>.
74+
///
75+
/// </para>
6776
/// </summary>
6877
public partial class CreateStreamGroupRequest : AmazonGameLiftStreamsRequest
6978
{
@@ -106,6 +115,13 @@ internal bool IsSetClientToken()
106115
/// using AssociateApplications. If not set when creating a stream group, you will need
107116
/// to call AssociateApplications later, before you can start streaming.
108117
/// </para>
118+
///
119+
/// <para>
120+
/// This value is an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html">Amazon
121+
/// Resource Name (ARN)</a> or ID that uniquely identifies the application resource. Example
122+
/// ARN: <c>arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6</c>.
123+
/// Example ID: <c>a-9ZY8X7Wv6</c>.
124+
/// </para>
109125
/// </summary>
110126
[AWSProperty(Min=1, Max=128)]
111127
public string DefaultApplicationIdentifier

0 commit comments

Comments
 (0)