Class: Aws::CodeStar::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeStar::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codestar/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.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
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.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
Methods included from Aws::ClientStubs
#api_requests, #stub_data, #stub_responses
Methods inherited from Seahorse::Client::Base
add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins
Methods included from Seahorse::Client::HandlerBuilder
#handle, #handle_request, #handle_response
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
375 376 377 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 375 def initialize(*args) super end |
Instance Method Details
#associate_team_member(params = {}) ⇒ Types::AssociateTeamMemberResult
Adds an IAM user to the team for an AWS CodeStar project.
426 427 428 429 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 426 def associate_team_member(params = {}, = {}) req = build_request(:associate_team_member, params) req.send_request() 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.
529 530 531 532 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 529 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.
588 589 590 591 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 588 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.
634 635 636 637 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 634 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.
666 667 668 669 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 666 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.
711 712 713 714 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 711 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.
750 751 752 753 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 750 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.
782 783 784 785 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 782 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.
820 821 822 823 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 820 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.
861 862 863 864 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 861 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.
900 901 902 903 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 900 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.
942 943 944 945 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 942 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.
982 983 984 985 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 982 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.
1017 1018 1019 1020 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1017 def tag_project(params = {}, = {}) req = build_request(:tag_project, params) req.send_request() end |
#untag_project(params = {}) ⇒ Struct
Removes tags from a project.
1043 1044 1045 1046 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1043 def untag_project(params = {}, = {}) req = build_request(:untag_project, params) req.send_request() end |
#update_project(params = {}) ⇒ Struct
Updates a project in AWS CodeStar.
1073 1074 1075 1076 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1073 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.
1129 1130 1131 1132 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1129 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.
1188 1189 1190 1191 |
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1188 def update_user_profile(params = {}, = {}) req = build_request(:update_user_profile, params) req.send_request() end |