Class: Aws::CodeStar::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeStar::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-codestar/client.rb
Overview
An API client for CodeStar. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::CodeStar::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_team_member(params = {}) ⇒ Types::AssociateTeamMemberResult
Adds an IAM user to the team for an AWS CodeStar project.
-
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates a project, including project resources.
-
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResult
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.
-
#delete_project(params = {}) ⇒ Types::DeleteProjectResult
Deletes a project, including project resources.
-
#delete_user_profile(params = {}) ⇒ Types::DeleteUserProfileResult
Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address.
-
#describe_project(params = {}) ⇒ Types::DescribeProjectResult
Describes a project and its resources.
-
#describe_user_profile(params = {}) ⇒ Types::DescribeUserProfileResult
Describes a user in AWS CodeStar and the user attributes across all projects.
-
#disassociate_team_member(params = {}) ⇒ Struct
Removes a user from a project.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResult
Lists all projects in AWS CodeStar associated with your AWS account.
-
#list_resources(params = {}) ⇒ Types::ListResourcesResult
Lists resources associated with a project in AWS CodeStar.
-
#list_tags_for_project(params = {}) ⇒ Types::ListTagsForProjectResult
Gets the tags for a project.
-
#list_team_members(params = {}) ⇒ Types::ListTeamMembersResult
Lists all team members associated with a project.
-
#list_user_profiles(params = {}) ⇒ Types::ListUserProfilesResult
Lists all the user profiles configured for your AWS account in AWS CodeStar.
-
#tag_project(params = {}) ⇒ Types::TagProjectResult
Adds tags to a project.
-
#untag_project(params = {}) ⇒ Struct
Removes tags from a project.
-
#update_project(params = {}) ⇒ Struct
Updates a project in AWS CodeStar.
-
#update_team_member(params = {}) ⇒ Types::UpdateTeamMemberResult
Updates a team member’s attributes in an AWS CodeStar project.
-
#update_user_profile(params = {}) ⇒ Types::UpdateUserProfileResult
Updates a user’s profile in AWS CodeStar.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
395 396 397 |
# File 'lib/aws-sdk-codestar/client.rb', line 395 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1239 1240 1241 |
# File 'lib/aws-sdk-codestar/client.rb', line 1239 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1242 1243 1244 |
# File 'lib/aws-sdk-codestar/client.rb', line 1242 def errors_module Errors end |
Instance Method Details
#associate_team_member(params = {}) ⇒ Types::AssociateTeamMemberResult
Adds an IAM user to the team for an AWS CodeStar project.
446 447 448 449 |
# File 'lib/aws-sdk-codestar/client.rb', line 446 def associate_team_member(params = {}, = {}) req = build_request(:associate_team_member, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 |
# File 'lib/aws-sdk-codestar/client.rb', line 1217 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-codestar' context[:gem_version] = '1.50.0' Seahorse::Client::Request.new(handlers, context) end |
#create_project(params = {}) ⇒ Types::CreateProjectResult
Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.
549 550 551 552 |
# File 'lib/aws-sdk-codestar/client.rb', line 549 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResult
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 CodeStar.
608 609 610 611 |
# File 'lib/aws-sdk-codestar/client.rb', line 608 def create_user_profile(params = {}, = {}) req = build_request(:create_user_profile, params) req.send_request() end |
#delete_project(params = {}) ⇒ Types::DeleteProjectResult
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 project.
654 655 656 657 |
# File 'lib/aws-sdk-codestar/client.rb', line 654 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_user_profile(params = {}) ⇒ Types::DeleteUserProfileResult
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 user.
686 687 688 689 |
# File 'lib/aws-sdk-codestar/client.rb', line 686 def delete_user_profile(params = {}, = {}) req = build_request(:delete_user_profile, params) req.send_request() end |
#describe_project(params = {}) ⇒ Types::DescribeProjectResult
Describes a project and its resources.
731 732 733 734 |
# File 'lib/aws-sdk-codestar/client.rb', line 731 def describe_project(params = {}, = {}) req = build_request(:describe_project, params) req.send_request() end |
#describe_user_profile(params = {}) ⇒ Types::DescribeUserProfileResult
Describes a user in AWS CodeStar and the user attributes across all projects.
770 771 772 773 |
# File 'lib/aws-sdk-codestar/client.rb', line 770 def describe_user_profile(params = {}, = {}) req = build_request(:describe_user_profile, params) req.send_request() end |
#disassociate_team_member(params = {}) ⇒ Struct
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 IAM.
802 803 804 805 |
# File 'lib/aws-sdk-codestar/client.rb', line 802 def disassociate_team_member(params = {}, = {}) req = build_request(:disassociate_team_member, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResult
Lists all projects in AWS CodeStar associated with your AWS account.
840 841 842 843 |
# File 'lib/aws-sdk-codestar/client.rb', line 840 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_resources(params = {}) ⇒ Types::ListResourcesResult
Lists resources associated with a project in AWS CodeStar.
881 882 883 884 |
# File 'lib/aws-sdk-codestar/client.rb', line 881 def list_resources(params = {}, = {}) req = build_request(:list_resources, params) req.send_request() end |
#list_tags_for_project(params = {}) ⇒ Types::ListTagsForProjectResult
Gets the tags for a project.
920 921 922 923 |
# File 'lib/aws-sdk-codestar/client.rb', line 920 def (params = {}, = {}) req = build_request(:list_tags_for_project, params) req.send_request() end |
#list_team_members(params = {}) ⇒ Types::ListTeamMembersResult
Lists all team members associated with a project.
962 963 964 965 |
# File 'lib/aws-sdk-codestar/client.rb', line 962 def list_team_members(params = {}, = {}) req = build_request(:list_team_members, params) req.send_request() end |
#list_user_profiles(params = {}) ⇒ Types::ListUserProfilesResult
Lists all the user profiles configured for your AWS account in AWS CodeStar.
1002 1003 1004 1005 |
# File 'lib/aws-sdk-codestar/client.rb', line 1002 def list_user_profiles(params = {}, = {}) req = build_request(:list_user_profiles, params) req.send_request() end |
#tag_project(params = {}) ⇒ Types::TagProjectResult
Adds tags to a project.
1037 1038 1039 1040 |
# File 'lib/aws-sdk-codestar/client.rb', line 1037 def tag_project(params = {}, = {}) req = build_request(:tag_project, params) req.send_request() end |
#untag_project(params = {}) ⇒ Struct
Removes tags from a project.
1063 1064 1065 1066 |
# File 'lib/aws-sdk-codestar/client.rb', line 1063 def untag_project(params = {}, = {}) req = build_request(:untag_project, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
Updates a project in AWS CodeStar.
1093 1094 1095 1096 |
# File 'lib/aws-sdk-codestar/client.rb', line 1093 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#update_team_member(params = {}) ⇒ Types::UpdateTeamMemberResult
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 resources.
1149 1150 1151 1152 |
# File 'lib/aws-sdk-codestar/client.rb', line 1149 def update_team_member(params = {}, = {}) req = build_request(:update_team_member, params) req.send_request() end |
#update_user_profile(params = {}) ⇒ Types::UpdateUserProfileResult
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.
1208 1209 1210 1211 |
# File 'lib/aws-sdk-codestar/client.rb', line 1208 def update_user_profile(params = {}, = {}) req = build_request(:update_user_profile, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
1232 1233 1234 |
# File 'lib/aws-sdk-codestar/client.rb', line 1232 def waiter_names [] end |