CodeStarClient Class
(QtAws::CodeStar::CodeStarClient)The CodeStarClient class provides access to the AWS CodeStar service. More...
| Header: | #include <CodeStarClient> |
| Inherits: | QtAws::Core::AwsAbstractClient |
Public Functions
| CodeStarClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) | |
| CodeStarClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0) |
- 12 public functions inherited from QtAws::Core::AwsAbstractClient
Public Slots
| AssociateTeamMemberResponse * | associateTeamMember(const AssociateTeamMemberRequest &request) |
| CreateProjectResponse * | createProject(const CreateProjectRequest &request) |
| CreateUserProfileResponse * | createUserProfile(const CreateUserProfileRequest &request) |
| DeleteProjectResponse * | deleteProject(const DeleteProjectRequest &request) |
| DeleteUserProfileResponse * | deleteUserProfile(const DeleteUserProfileRequest &request) |
| DescribeProjectResponse * | describeProject(const DescribeProjectRequest &request) |
| DescribeUserProfileResponse * | describeUserProfile(const DescribeUserProfileRequest &request) |
| DisassociateTeamMemberResponse * | disassociateTeamMember(const DisassociateTeamMemberRequest &request) |
| ListProjectsResponse * | listProjects(const ListProjectsRequest &request) |
| ListResourcesResponse * | listResources(const ListResourcesRequest &request) |
| ListTagsForProjectResponse * | listTagsForProject(const ListTagsForProjectRequest &request) |
| ListTeamMembersResponse * | listTeamMembers(const ListTeamMembersRequest &request) |
| ListUserProfilesResponse * | listUserProfiles(const ListUserProfilesRequest &request) |
| TagProjectResponse * | tagProject(const TagProjectRequest &request) |
| UntagProjectResponse * | untagProject(const UntagProjectRequest &request) |
| UpdateProjectResponse * | updateProject(const UpdateProjectRequest &request) |
| UpdateTeamMemberResponse * | updateTeamMember(const UpdateTeamMemberRequest &request) |
| UpdateUserProfileResponse * | updateUserProfile(const UpdateUserProfileRequest &request) |
Additional Inherited Members
- 2 protected functions inherited from QtAws::Core::AwsAbstractClient
Detailed Description
The CodeStarClient class provides access to the AWS CodeStar service.
<fullname>AWS CodeStar</fullname>
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>
You can use the AWS CodeStar API to work
with>
Projects and their resources, by calling the
following> <ul> <li>
<code>DeleteProject</code>, which deletes a
project> </li> <li>
<code>DescribeProject</code>, which lists the attributes of a
project> </li> <li>
<code>ListProjects</code>, which lists all projects associated with your AWS
account> </li> <li>
<code>ListResources</code>, which lists the resources associated with a
project> </li> <li>
<code>ListTagsForProject</code>, which lists the tags associated with a
project> </li> <li>
<code>TagProject</code>, which adds tags to a
project> </li> <li>
<code>UntagProject</code>, which removes tags from a
project> </li> <li>
<code>UpdateProject</code>, which updates the attributes of a
project> </li> </ul>
Teams and team members, by calling the
following> <ul> <li>
<code>AssociateTeamMember</code>, which adds an IAM user to the team for a
project> </li> <li>
<code>DisassociateTeamMember</code>, which removes an IAM user from the team for a
project> </li> <li>
<code>ListTeamMembers</code>, which lists all the IAM users in the team for a project, including their roles and
attributes> </li> <li>
<code>UpdateTeamMember</code>, which updates a team member's attributes in a
project> </li> </ul>
Users, by calling the
following> <ul> <li>
<code>CreateUserProfile</code>, which creates a user profile that contains data associated with the user across all
projects> </li> <li>
<code>DeleteUserProfile</code>, which deletes all user profile information across all
projects> </li> <li>
<code>DescribeUserProfile</code>, which describes the profile of a
user> </li> <li>
<code>ListUserProfiles</code>, which lists all user
profiles> </li> <li>
<code>UpdateUserProfile</code>, which updates the profile for a
Member Function Documentation
CodeStarClient::CodeStarClient(const QtAws::Core::AwsRegion::Region region = QtAws::Core::AwsRegion::InvalidRegion, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
Constructs a CodeStarClient object.
The new client object will region, credentials, and manager for network operations.
The new object will be owned by parent, if set.
CodeStarClient::CodeStarClient(const QUrl &endpoint, QtAws::Core::AwsAbstractCredentials *credentials = NULL, QNetworkAccessManager * const manager = NULL, QObject * const parent = 0)
This function overloads CodeStarClient().
This overload allows the caller to specify the specific endpoint to send requests to. Typically, it is easier to use the alternative constructor, which allows the caller to specify an AWS region instead, in which case this client will determine the correct endpoint for the given region automatically (via AwsEndpoint::getEndpoint).
See also QtAws::Core::AwsEndpoint::getEndpoint.
[slot] AssociateTeamMemberResponse *CodeStarClient::associateTeamMember(const AssociateTeamMemberRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an AssociateTeamMemberResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Adds an IAM user to the team for an AWS CodeStar
[slot] CreateProjectResponse *CodeStarClient::createProject(const CreateProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an CreateProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Reserved for future use. To create a project, use the AWS CodeStar
[slot] CreateUserProfileResponse *CodeStarClient::createUserProfile(const CreateUserProfileRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an CreateUserProfileResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS
[slot] DeleteProjectResponse *CodeStarClient::deleteProject(const DeleteProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an DeleteProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the
[slot] DeleteUserProfileResponse *CodeStarClient::deleteUserProfile(const DeleteUserProfileRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an DeleteUserProfileResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that
[slot] DescribeProjectResponse *CodeStarClient::describeProject(const DescribeProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an DescribeProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes a project and its
[slot] DescribeUserProfileResponse *CodeStarClient::describeUserProfile(const DescribeUserProfileRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an DescribeUserProfileResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Describes a user in AWS CodeStar and the user attributes across all
[slot] DisassociateTeamMemberResponse *CodeStarClient::disassociateTeamMember(const DisassociateTeamMemberRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an DisassociateTeamMemberResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from
[slot] ListProjectsResponse *CodeStarClient::listProjects(const ListProjectsRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an ListProjectsResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Lists all projects in AWS CodeStar associated with your AWS
[slot] ListResourcesResponse *CodeStarClient::listResources(const ListResourcesRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an ListResourcesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Lists resources associated with a project in AWS
[slot] ListTagsForProjectResponse *CodeStarClient::listTagsForProject(const ListTagsForProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an ListTagsForProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Gets the tags for a
[slot] ListTeamMembersResponse *CodeStarClient::listTeamMembers(const ListTeamMembersRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an ListTeamMembersResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Lists all team members associated with a
[slot] ListUserProfilesResponse *CodeStarClient::listUserProfiles(const ListUserProfilesRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an ListUserProfilesResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Lists all the user profiles configured for your AWS account in AWS
[slot] TagProjectResponse *CodeStarClient::tagProject(const TagProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an TagProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Adds tags to a
[slot] UntagProjectResponse *CodeStarClient::untagProject(const UntagProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an UntagProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Removes tags from a
[slot] UpdateProjectResponse *CodeStarClient::updateProject(const UpdateProjectRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an UpdateProjectResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates a project in AWS
[slot] UpdateTeamMemberResponse *CodeStarClient::updateTeamMember(const UpdateTeamMemberRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an UpdateTeamMemberResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project
[slot] UpdateUserProfileResponse *CodeStarClient::updateUserProfile(const UpdateUserProfileRequest &request)
Sends request to the CodeStarClient service, and returns a pointer to an UpdateUserProfileResponse object to track the result.
Note: The caller is to take responsbility for the resulting pointer.
Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.
© 2018 Paul Colby Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.