Class: Aws::CodeCatalyst::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeCatalyst::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb
Overview
An API client for CodeCatalyst. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CodeCatalyst::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
-
#create_access_token(params = {}) ⇒ Types::CreateAccessTokenResponse
Creates a personal access token (PAT) for the current user.
-
#create_dev_environment(params = {}) ⇒ Types::CreateDevEnvironmentResponse
Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.
-
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a project in a specified space.
-
#create_source_repository(params = {}) ⇒ Types::CreateSourceRepositoryResponse
Creates an empty Git-based source repository in a specified project.
-
#create_source_repository_branch(params = {}) ⇒ Types::CreateSourceRepositoryBranchResponse
Creates a branch in a specified source repository in Amazon CodeCatalyst.
-
#delete_access_token(params = {}) ⇒ Struct
Deletes a specified personal access token (PAT).
-
#delete_dev_environment(params = {}) ⇒ Types::DeleteDevEnvironmentResponse
Deletes a Dev Environment.
-
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes a project in a space.
-
#delete_source_repository(params = {}) ⇒ Types::DeleteSourceRepositoryResponse
Deletes a source repository in Amazon CodeCatalyst.
-
#delete_space(params = {}) ⇒ Types::DeleteSpaceResponse
Deletes a space.
-
#get_dev_environment(params = {}) ⇒ Types::GetDevEnvironmentResponse
Returns information about a Dev Environment for a source repository in a project.
-
#get_project(params = {}) ⇒ Types::GetProjectResponse
Returns information about a project.
-
#get_source_repository(params = {}) ⇒ Types::GetSourceRepositoryResponse
Returns information about a source repository.
-
#get_source_repository_clone_urls(params = {}) ⇒ Types::GetSourceRepositoryCloneUrlsResponse
Returns information about the URLs that can be used with a Git client to clone a source repository.
-
#get_space(params = {}) ⇒ Types::GetSpaceResponse
Returns information about an space.
-
#get_subscription(params = {}) ⇒ Types::GetSubscriptionResponse
Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
-
#get_user_details(params = {}) ⇒ Types::GetUserDetailsResponse
Returns information about a user.
-
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Returns information about a workflow.
-
#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse
Returns information about a specified run of a workflow.
-
#list_access_tokens(params = {}) ⇒ Types::ListAccessTokensResponse
Lists all personal access tokens (PATs) associated with the user who calls the API.
-
#list_dev_environment_sessions(params = {}) ⇒ Types::ListDevEnvironmentSessionsResponse
Retrieves a list of active sessions for a Dev Environment in a project.
-
#list_dev_environments(params = {}) ⇒ Types::ListDevEnvironmentsResponse
Retrieves a list of Dev Environments in a project.
-
#list_event_logs(params = {}) ⇒ Types::ListEventLogsResponse
Retrieves a list of events that occurred during a specific time in a space.
-
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Retrieves a list of projects.
-
#list_source_repositories(params = {}) ⇒ Types::ListSourceRepositoriesResponse
Retrieves a list of source repositories in a project.
-
#list_source_repository_branches(params = {}) ⇒ Types::ListSourceRepositoryBranchesResponse
Retrieves a list of branches in a specified source repository.
-
#list_spaces(params = {}) ⇒ Types::ListSpacesResponse
Retrieves a list of spaces.
-
#list_workflow_runs(params = {}) ⇒ Types::ListWorkflowRunsResponse
Retrieves a list of workflow runs of a specified workflow.
-
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Retrieves a list of workflows in a specified project.
-
#start_dev_environment(params = {}) ⇒ Types::StartDevEnvironmentResponse
Starts a specified Dev Environment and puts it into an active state.
-
#start_dev_environment_session(params = {}) ⇒ Types::StartDevEnvironmentSessionResponse
Starts a session for a specified Dev Environment.
-
#start_workflow_run(params = {}) ⇒ Types::StartWorkflowRunResponse
Begins a run of a specified workflow.
-
#stop_dev_environment(params = {}) ⇒ Types::StopDevEnvironmentResponse
Pauses a specified Dev Environment and places it in a non-running state.
-
#stop_dev_environment_session(params = {}) ⇒ Types::StopDevEnvironmentSessionResponse
Stops a session for a specified Dev Environment.
-
#update_dev_environment(params = {}) ⇒ Types::UpdateDevEnvironmentResponse
Changes one or more values for a Dev Environment.
-
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Changes one or more values for a project.
-
#update_space(params = {}) ⇒ Types::UpdateSpaceResponse
Changes one or more values for a space.
-
#verify_session(params = {}) ⇒ Types::VerifySessionResponse
Verifies whether the calling user has a valid Amazon CodeCatalyst login and session.
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.
385 386 387 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 385 def initialize(*args) super end |
Instance Method Details
#create_access_token(params = {}) ⇒ Types::CreateAccessTokenResponse
Creates a personal access token (PAT) for the current user. A personal access token (PAT) is similar to a password. It is associated with your user identity for use across all spaces and projects in Amazon CodeCatalyst. You use PATs to access CodeCatalyst from resources that include integrated development environments (IDEs) and Git-based source repositories. PATs represent you in Amazon CodeCatalyst and you can manage them in your user settings.For more information, see Managing personal access tokens in Amazon CodeCatalyst.
440 441 442 443 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 440 def create_access_token(params = {}, = {}) req = build_request(:create_access_token, params) req.send_request() end |
#create_dev_environment(params = {}) ⇒ Types::CreateDevEnvironmentResponse
Creates a Dev Environment in Amazon CodeCatalyst, a cloud-based development environment that you can use to quickly work on the code stored in the source repositories of your project.
555 556 557 558 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 555 def create_dev_environment(params = {}, = {}) req = build_request(:create_dev_environment, params) req.send_request() end |
#create_project(params = {}) ⇒ Types::CreateProjectResponse
Creates a project in a specified space.
599 600 601 602 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 599 def create_project(params = {}, = {}) req = build_request(:create_project, params) req.send_request() end |
#create_source_repository(params = {}) ⇒ Types::CreateSourceRepositoryResponse
Creates an empty Git-based source repository in a specified project.
The repository is created with an initial empty commit with a default
branch named main
.
652 653 654 655 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 652 def create_source_repository(params = {}, = {}) req = build_request(:create_source_repository, params) req.send_request() end |
#create_source_repository_branch(params = {}) ⇒ Types::CreateSourceRepositoryBranchResponse
Creates a branch in a specified source repository in Amazon CodeCatalyst.
710 711 712 713 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 710 def create_source_repository_branch(params = {}, = {}) req = build_request(:create_source_repository_branch, params) req.send_request() end |
#delete_access_token(params = {}) ⇒ Struct
Deletes a specified personal access token (PAT). A personal access token can only be deleted by the user who created it.
735 736 737 738 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 735 def delete_access_token(params = {}, = {}) req = build_request(:delete_access_token, params) req.send_request() end |
#delete_dev_environment(params = {}) ⇒ Types::DeleteDevEnvironmentResponse
Deletes a Dev Environment.
777 778 779 780 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 777 def delete_dev_environment(params = {}, = {}) req = build_request(:delete_dev_environment, params) req.send_request() end |
#delete_project(params = {}) ⇒ Types::DeleteProjectResponse
Deletes a project in a space.
814 815 816 817 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 814 def delete_project(params = {}, = {}) req = build_request(:delete_project, params) req.send_request() end |
#delete_source_repository(params = {}) ⇒ Types::DeleteSourceRepositoryResponse
Deletes a source repository in Amazon CodeCatalyst. You cannot use this API to delete a linked repository. It can only be used to delete a Amazon CodeCatalyst source repository.
856 857 858 859 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 856 def delete_source_repository(params = {}, = {}) req = build_request(:delete_source_repository, params) req.send_request() end |
#delete_space(params = {}) ⇒ Types::DeleteSpaceResponse
Deletes a space.
Deleting a space cannot be undone. Additionally, since space names must be unique across Amazon CodeCatalyst, you cannot reuse names of deleted spaces.
891 892 893 894 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 891 def delete_space(params = {}, = {}) req = build_request(:delete_space, params) req.send_request() end |
#get_dev_environment(params = {}) ⇒ Types::GetDevEnvironmentResponse
Returns information about a Dev Environment for a source repository in a project. Dev Environments are specific to the user who creates them.
960 961 962 963 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 960 def get_dev_environment(params = {}, = {}) req = build_request(:get_dev_environment, params) req.send_request() end |
#get_project(params = {}) ⇒ Types::GetProjectResponse
Returns information about a project.
998 999 1000 1001 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 998 def get_project(params = {}, = {}) req = build_request(:get_project, params) req.send_request() end |
#get_source_repository(params = {}) ⇒ Types::GetSourceRepositoryResponse
Returns information about a source repository.
1044 1045 1046 1047 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1044 def get_source_repository(params = {}, = {}) req = build_request(:get_source_repository, params) req.send_request() end |
#get_source_repository_clone_urls(params = {}) ⇒ Types::GetSourceRepositoryCloneUrlsResponse
Returns information about the URLs that can be used with a Git client to clone a source repository.
1081 1082 1083 1084 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1081 def get_source_repository_clone_urls(params = {}, = {}) req = build_request(:get_source_repository_clone_urls, params) req.send_request() end |
#get_space(params = {}) ⇒ Types::GetSpaceResponse
Returns information about an space.
1115 1116 1117 1118 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1115 def get_space(params = {}, = {}) req = build_request(:get_space, params) req.send_request() end |
#get_subscription(params = {}) ⇒ Types::GetSubscriptionResponse
Returns information about the Amazon Web Services account used for billing purposes and the billing plan for the space.
1150 1151 1152 1153 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1150 def get_subscription(params = {}, = {}) req = build_request(:get_subscription, params) req.send_request() end |
#get_user_details(params = {}) ⇒ Types::GetUserDetailsResponse
Returns information about a user.
1191 1192 1193 1194 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1191 def get_user_details(params = {}, = {}) req = build_request(:get_user_details, params) req.send_request() end |
#get_workflow(params = {}) ⇒ Types::GetWorkflowResponse
Returns information about a workflow.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1248 def get_workflow(params = {}, = {}) req = build_request(:get_workflow, params) req.send_request() end |
#get_workflow_run(params = {}) ⇒ Types::GetWorkflowRunResponse
Returns information about a specified run of a workflow.
1301 1302 1303 1304 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1301 def get_workflow_run(params = {}, = {}) req = build_request(:get_workflow_run, params) req.send_request() end |
#list_access_tokens(params = {}) ⇒ Types::ListAccessTokensResponse
Lists all personal access tokens (PATs) associated with the user who calls the API. You can only list PATs associated with your Amazon Web Services Builder ID.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1346 1347 1348 1349 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1346 def list_access_tokens(params = {}, = {}) req = build_request(:list_access_tokens, params) req.send_request() end |
#list_dev_environment_sessions(params = {}) ⇒ Types::ListDevEnvironmentSessionsResponse
Retrieves a list of active sessions for a Dev Environment in a project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1404 def list_dev_environment_sessions(params = {}, = {}) req = build_request(:list_dev_environment_sessions, params) req.send_request() end |
#list_dev_environments(params = {}) ⇒ Types::ListDevEnvironmentsResponse
Retrieves a list of Dev Environments in a project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1481 1482 1483 1484 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1481 def list_dev_environments(params = {}, = {}) req = build_request(:list_dev_environments, params) req.send_request() end |
#list_event_logs(params = {}) ⇒ Types::ListEventLogsResponse
Retrieves a list of events that occurred during a specific time in a space. You can use these events to audit user and system activity in a space. For more information, see Monitoring in the Amazon CodeCatalyst User Guide.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1589 1590 1591 1592 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1589 def list_event_logs(params = {}, = {}) req = build_request(:list_event_logs, params) req.send_request() end |
#list_projects(params = {}) ⇒ Types::ListProjectsResponse
Retrieves a list of projects.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1647 def list_projects(params = {}, = {}) req = build_request(:list_projects, params) req.send_request() end |
#list_source_repositories(params = {}) ⇒ Types::ListSourceRepositoriesResponse
Retrieves a list of source repositories in a project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1700 1701 1702 1703 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1700 def list_source_repositories(params = {}, = {}) req = build_request(:list_source_repositories, params) req.send_request() end |
#list_source_repository_branches(params = {}) ⇒ Types::ListSourceRepositoryBranchesResponse
Retrieves a list of branches in a specified source repository.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1756 1757 1758 1759 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1756 def list_source_repository_branches(params = {}, = {}) req = build_request(:list_source_repository_branches, params) req.send_request() end |
#list_spaces(params = {}) ⇒ Types::ListSpacesResponse
Retrieves a list of spaces.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1793 1794 1795 1796 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1793 def list_spaces(params = {}, = {}) req = build_request(:list_spaces, params) req.send_request() end |
#list_workflow_runs(params = {}) ⇒ Types::ListWorkflowRunsResponse
Retrieves a list of workflow runs of a specified workflow.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1861 1862 1863 1864 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1861 def list_workflow_runs(params = {}, = {}) req = build_request(:list_workflow_runs, params) req.send_request() end |
#list_workflows(params = {}) ⇒ Types::ListWorkflowsResponse
Retrieves a list of workflows in a specified project.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1925 1926 1927 1928 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1925 def list_workflows(params = {}, = {}) req = build_request(:list_workflows, params) req.send_request() end |
#start_dev_environment(params = {}) ⇒ Types::StartDevEnvironmentResponse
Starts a specified Dev Environment and puts it into an active state.
1987 1988 1989 1990 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 1987 def start_dev_environment(params = {}, = {}) req = build_request(:start_dev_environment, params) req.send_request() end |
#start_dev_environment_session(params = {}) ⇒ Types::StartDevEnvironmentSessionResponse
Starts a session for a specified Dev Environment.
2042 2043 2044 2045 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2042 def start_dev_environment_session(params = {}, = {}) req = build_request(:start_dev_environment_session, params) req.send_request() end |
#start_workflow_run(params = {}) ⇒ Types::StartWorkflowRunResponse
Begins a run of a specified workflow.
2096 2097 2098 2099 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2096 def start_workflow_run(params = {}, = {}) req = build_request(:start_workflow_run, params) req.send_request() end |
#stop_dev_environment(params = {}) ⇒ Types::StopDevEnvironmentResponse
Pauses a specified Dev Environment and places it in a non-running state. Stopped Dev Environments do not consume compute minutes.
2139 2140 2141 2142 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2139 def stop_dev_environment(params = {}, = {}) req = build_request(:stop_dev_environment, params) req.send_request() end |
#stop_dev_environment_session(params = {}) ⇒ Types::StopDevEnvironmentSessionResponse
Stops a session for a specified Dev Environment.
2187 2188 2189 2190 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2187 def stop_dev_environment_session(params = {}, = {}) req = build_request(:stop_dev_environment_session, params) req.send_request() end |
#update_dev_environment(params = {}) ⇒ Types::UpdateDevEnvironmentResponse
Changes one or more values for a Dev Environment. Updating certain values of the Dev Environment will cause a restart.
2283 2284 2285 2286 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2283 def update_dev_environment(params = {}, = {}) req = build_request(:update_dev_environment, params) req.send_request() end |
#update_project(params = {}) ⇒ Types::UpdateProjectResponse
Changes one or more values for a project.
2325 2326 2327 2328 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2325 def update_project(params = {}, = {}) req = build_request(:update_project, params) req.send_request() end |
#update_space(params = {}) ⇒ Types::UpdateSpaceResponse
Changes one or more values for a space.
2361 2362 2363 2364 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2361 def update_space(params = {}, = {}) req = build_request(:update_space, params) req.send_request() end |
#verify_session(params = {}) ⇒ Types::VerifySessionResponse
Verifies whether the calling user has a valid Amazon CodeCatalyst login and session. If successful, this returns the ID of the user in Amazon CodeCatalyst.
2382 2383 2384 2385 |
# File 'gems/aws-sdk-codecatalyst/lib/aws-sdk-codecatalyst/client.rb', line 2382 def verify_session(params = {}, = {}) req = build_request(:verify_session, params) req.send_request() end |