Skip to content

Commit

Permalink
Updates SDK documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
awstools committed May 9, 2017
1 parent b6f5b65 commit 75343e9
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 19 deletions.
20 changes: 10 additions & 10 deletions apis/codestar-2017-04-19.normal.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
{"shape":"ProjectConfigurationException"},
{"shape":"ConcurrentModificationException"}
],
"documentation":"<p>Creates a project in AWS CodeStar with minimal structure and no resources.</p>"
"documentation":"<p>Reserved for future use. To create a project, use the AWS CodeStar console.</p>"
},
"CreateUserProfile":{
"name":"CreateUserProfile",
Expand Down Expand Up @@ -308,19 +308,19 @@
"members":{
"name":{
"shape":"ProjectName",
"documentation":"<p>The friendly name for the project. This friendly name serves as the basis for the names for resources associated with the project, such as a repository name in AWS CodeCommit. The name is limited to 100 characters and cannot contain certain restricted symbols. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/limits.html\">Limits</a> in the AWS CodeStar User Guide.</p>"
"documentation":"<p>Reserved for future use.</p>"
},
"id":{
"shape":"ProjectId",
"documentation":"<p>The ID for the AWS CodeStar project. Project IDs must be unique within an AWS account. Project IDs cannot exceed 15 characters and cannot contain capital letters and other restricted symbols. For more information, see <a href=\"http://docs.aws.amazon.com/codestar/latest/userguide/limits.html\">Limits</a> in the AWS CodeStar User Guide.</p>"
"documentation":"<p>Reserved for future use.</p>"
},
"description":{
"shape":"ProjectDescription",
"documentation":"<p>Optional. The description for the project.</p>"
"documentation":"<p>Reserved for future use.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>A user- or system-generated token that identifies the entity that requested project creation. This token can be used to repeat the request. It can also be used to identify which user or system made the request in DescribeProject and ListProjects.</p>"
"documentation":"<p>Reserved for future use.</p>"
}
}
},
Expand All @@ -333,19 +333,19 @@
"members":{
"id":{
"shape":"ProjectId",
"documentation":"<p>The ID for the project.</p>"
"documentation":"<p>Reserved for future use.</p>"
},
"arn":{
"shape":"ProjectArn",
"documentation":"<p>The Amazon Resource Name (ARN) for the project.</p>"
"documentation":"<p>Reserved for future use.</p>"
},
"clientRequestToken":{
"shape":"ClientRequestToken",
"documentation":"<p>The user- or system-generated token from the initial request that can be used to repeat the request. It can also be used to identify which user or system made the request in DescribeProject and ListProjects.</p>"
"documentation":"<p>Reserved for future use.</p>"
},
"projectTemplateId":{
"shape":"ProjectTemplateId",
"documentation":"<p>The ID for the AWS CodeStar project template used to create the project.</p>"
"documentation":"<p>Reserved for future use.</p>"
}
}
},
Expand Down Expand Up @@ -1059,5 +1059,5 @@
"exception":true
}
},
"documentation":"<fullname>AWS CodeStar</fullname> <p>This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.</p> <p>You can use the AWS CodeStar API to work with:</p> <p>Projects and their resources, by calling the following:</p> <ul> <li> <p> <a>CreateProject</a>, which creates an empty project in AWS CodeStar with no resources.</p> </li> <li> <p> <a>DeleteProject</a>, which deletes a project in AWS CodeStar.</p> </li> <li> <p> <a>DescribeProject</a>, which lists the attributes of a project.</p> </li> <li> <p> <a>ListProjects</a>, which lists all AWS CodeStar projects associated with your AWS account.</p> </li> <li> <p> <a>ListResources</a>, which lists the resources associated with an AWS CodeStar project.</p> </li> <li> <p> <a>UpdateProject</a>, which updates the attributes of an AWS CodeStar project.</p> </li> </ul> <p>Teams and team members, by calling the following:</p> <ul> <li> <p> <a>AssociateTeamMember</a>, which adds an IAM user to the team for an AWS CodeStar project.</p> </li> <li> <p> <a>DisassociateTeamMember</a>, which removes an IAM user from the team for an AWS CodeStar project.</p> </li> <li> <p> <a>ListTeamMembers</a>, which lists all the IAM users in the team for an AWS CodeStar project, including their roles and attributes.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <a>CreateUserProfile</a>, which creates a user profile that contains data associated with the user across all AWS CodeStar projects.</p> </li> <li> <p> <a>DeleteUserProfile</a>, which deletes all user profile information across all AWS CodeStar projects.</p> </li> <li> <p> <a>DescribeUserProfile</a>, which describes the profile of a user.</p> </li> <li> <p> <a>ListUserProfiles</a>, which lists all AWS CodeStar user profiles.</p> </li> <li> <p> <a>UpdateUserProfile</a>, which updates the profile for an AWS CodeStar user. </p> </li> </ul>"
"documentation":"<fullname>AWS CodeStar</fullname> <p>This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.</p> <p>You can use the AWS CodeStar API to work with:</p> <p>Projects and their resources, by calling the following:</p> <ul> <li> <p> <a>DeleteProject</a>, which deletes a project in AWS CodeStar.</p> </li> <li> <p> <a>DescribeProject</a>, which lists the attributes of a project.</p> </li> <li> <p> <a>ListProjects</a>, which lists all AWS CodeStar projects associated with your AWS account.</p> </li> <li> <p> <a>ListResources</a>, which lists the resources associated with an AWS CodeStar project.</p> </li> <li> <p> <a>UpdateProject</a>, which updates the attributes of an AWS CodeStar project.</p> </li> </ul> <p>Teams and team members, by calling the following:</p> <ul> <li> <p> <a>AssociateTeamMember</a>, which adds an IAM user to the team for an AWS CodeStar project.</p> </li> <li> <p> <a>DisassociateTeamMember</a>, which removes an IAM user from the team for an AWS CodeStar project.</p> </li> <li> <p> <a>ListTeamMembers</a>, which lists all the IAM users in the team for an AWS CodeStar project, including their roles and attributes.</p> </li> </ul> <p>Users, by calling the following:</p> <ul> <li> <p> <a>CreateUserProfile</a>, which creates a user profile that contains data associated with the user across all AWS CodeStar projects.</p> </li> <li> <p> <a>DeleteUserProfile</a>, which deletes all user profile information across all AWS CodeStar projects.</p> </li> <li> <p> <a>DescribeUserProfile</a>, which describes the profile of a user.</p> </li> <li> <p> <a>ListUserProfiles</a>, which lists all AWS CodeStar user profiles.</p> </li> <li> <p> <a>UpdateUserProfile</a>, which updates the profile for an AWS CodeStar user. </p> </li> </ul>"
}
5 changes: 5 additions & 0 deletions apis/workspaces-2015-04-08.examples.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"version": "1.0",
"examples": {
}
}
15 changes: 8 additions & 7 deletions apis/workspaces-2015-04-08.normal.json
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
{
"version":"2.0",
"metadata":{
"uid":"workspaces-2015-04-08",
"apiVersion":"2015-04-08",
"endpointPrefix":"workspaces",
"jsonVersion":"1.1",
"protocol":"json",
"serviceFullName":"Amazon WorkSpaces",
"signatureVersion":"v4",
"targetPrefix":"WorkspacesService"
"targetPrefix":"WorkspacesService",
"uid":"workspaces-2015-04-08"
},
"operations":{
"CreateTags":{
Expand Down Expand Up @@ -137,7 +137,7 @@
{"shape":"AccessDeniedException"},
{"shape":"ResourceUnavailableException"}
],
"documentation":"<p>Modifies the WorkSpace properties, including the RunningMode and AutoStop time.</p>"
"documentation":"<p>Modifies the WorkSpace properties, including the running mode and AutoStop time.</p>"
},
"RebootWorkspaces":{
"name":"RebootWorkspaces",
Expand Down Expand Up @@ -167,7 +167,7 @@
},
"input":{"shape":"StartWorkspacesRequest"},
"output":{"shape":"StartWorkspacesResult"},
"documentation":"<p>Starts the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to “STOPPED.</p>"
"documentation":"<p>Starts the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of STOPPED.</p>"
},
"StopWorkspaces":{
"name":"StopWorkspaces",
Expand All @@ -177,7 +177,7 @@
},
"input":{"shape":"StopWorkspacesRequest"},
"output":{"shape":"StopWorkspacesResult"},
"documentation":"<p> Stops the specified WorkSpaces. The API only works with WorkSpaces that have RunningMode configured as AutoStop and the State set to AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.</p>"
"documentation":"<p> Stops the specified WorkSpaces. The WorkSpaces must have a running mode of AutoStop and a state of AVAILABLE, IMPAIRED, UNHEALTHY, or ERROR.</p>"
},
"TerminateWorkspaces":{
"name":"TerminateWorkspaces",
Expand All @@ -200,6 +200,7 @@
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The user is not authorized to access a resource.</p>",
"exception":true
},
"Alias":{"type":"string"},
Expand Down Expand Up @@ -595,7 +596,7 @@
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The specified WorkSpace has an invalid state for this operation.</p>",
"documentation":"<p>The state of the WorkSpace is not valid for this operation.</p>",
"exception":true
},
"IpAddress":{"type":"string"},
Expand Down Expand Up @@ -931,7 +932,7 @@
"members":{
"message":{"shape":"ExceptionMessage"}
},
"documentation":"<p>The WorkSpace does not have the supported configuration for this operation. For more information, see the <a href=\"http://docs.aws.amazon.com/workspaces/latest/adminguide\">Amazon WorkSpaces Administration Guide</a>. </p>",
"documentation":"<p>The configuration of this WorkSpace is not supported for this operation. For more information, see the <a href=\"http://docs.aws.amazon.com/workspaces/latest/adminguide/\">Amazon WorkSpaces Administration Guide</a>. </p>",
"exception":true
},
"UserName":{
Expand Down
4 changes: 2 additions & 2 deletions apis/workspaces-2015-04-08.paginators.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@
"result_key": "Directories"
},
"DescribeWorkspaces": {
"limit_key": "Limit",
"input_token": "NextToken",
"limit_key": "Limit",
"output_token": "NextToken",
"result_key": "Workspaces"
}
}
}
}

0 comments on commit 75343e9

Please sign in to comment.