Class: Aws::CodeConnections::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeConnections::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb
Overview
An API client for CodeConnections. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CodeConnections::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_connection(params = {}) ⇒ Types::CreateConnectionOutput
Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories.
-
#create_host(params = {}) ⇒ Types::CreateHostOutput
Creates a resource that represents the infrastructure where a third-party provider is installed.
-
#create_repository_link(params = {}) ⇒ Types::CreateRepositoryLinkOutput
Creates a link to a specified external Git repository.
-
#create_sync_configuration(params = {}) ⇒ Types::CreateSyncConfigurationOutput
Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource.
-
#delete_connection(params = {}) ⇒ Struct
The connection to be deleted.
-
#delete_host(params = {}) ⇒ Struct
The host to be deleted.
-
#delete_repository_link(params = {}) ⇒ Struct
Deletes the association between your connection and a specified external Git repository.
-
#delete_sync_configuration(params = {}) ⇒ Struct
Deletes the sync configuration for a specified repository and connection.
-
#get_connection(params = {}) ⇒ Types::GetConnectionOutput
Returns the connection ARN and details such as status, owner, and provider type.
-
#get_host(params = {}) ⇒ Types::GetHostOutput
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
-
#get_repository_link(params = {}) ⇒ Types::GetRepositoryLinkOutput
Returns details about a repository link.
-
#get_repository_sync_status(params = {}) ⇒ Types::GetRepositorySyncStatusOutput
Returns details about the sync status for a repository.
-
#get_resource_sync_status(params = {}) ⇒ Types::GetResourceSyncStatusOutput
Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
-
#get_sync_blocker_summary(params = {}) ⇒ Types::GetSyncBlockerSummaryOutput
Returns a list of the most recent sync blockers.
-
#get_sync_configuration(params = {}) ⇒ Types::GetSyncConfigurationOutput
Returns details about a sync configuration, including the sync type and resource name.
-
#list_connections(params = {}) ⇒ Types::ListConnectionsOutput
Lists the connections associated with your account.
-
#list_hosts(params = {}) ⇒ Types::ListHostsOutput
Lists the hosts associated with your account.
-
#list_repository_links(params = {}) ⇒ Types::ListRepositoryLinksOutput
Lists the repository links created for connections in your account.
-
#list_repository_sync_definitions(params = {}) ⇒ Types::ListRepositorySyncDefinitionsOutput
Lists the repository sync definitions for repository links in your account.
-
#list_sync_configurations(params = {}) ⇒ Types::ListSyncConfigurationsOutput
Returns a list of sync configurations for a specified repository.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Gets the set of key-value pairs (metadata) that are used to manage the resource.
-
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Amazon Web Services resource.
-
#update_host(params = {}) ⇒ Struct
Updates a specified host with the provided configurations.
-
#update_repository_link(params = {}) ⇒ Types::UpdateRepositoryLinkOutput
Updates the association between your connection and a specified external Git repository.
-
#update_sync_blocker(params = {}) ⇒ Types::UpdateSyncBlockerOutput
Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
-
#update_sync_configuration(params = {}) ⇒ Types::UpdateSyncConfigurationOutput
Updates the sync configuration for your connection and a specified external Git repository.
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.
420 421 422 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 420 def initialize(*args) super end |
Instance Method Details
#create_connection(params = {}) ⇒ Types::CreateConnectionOutput
Creates a connection that can then be given to other Amazon Web Services services like CodePipeline so that it can access third-party code repositories. The connection is in pending status until the third-party connection handshake is completed from the console.
475 476 477 478 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 475 def create_connection(params = {}, = {}) req = build_request(:create_connection, params) req.send_request() end |
#create_host(params = {}) ⇒ Types::CreateHostOutput
Creates a resource that represents the infrastructure where a third-party provider is installed. The host is used when you create connections to an installed third-party provider type, such as GitHub Enterprise Server. You create one host for all connections to that provider.
PENDING
status by
default. You can make its status AVAILABLE
by setting up the host
in the console.
549 550 551 552 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 549 def create_host(params = {}, = {}) req = build_request(:create_host, params) req.send_request() end |
#create_repository_link(params = {}) ⇒ Types::CreateRepositoryLinkOutput
Creates a link to a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.
609 610 611 612 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 609 def create_repository_link(params = {}, = {}) req = build_request(:create_repository_link, params) req.send_request() end |
#create_sync_configuration(params = {}) ⇒ Types::CreateSyncConfigurationOutput
Creates a sync configuration which allows Amazon Web Services to sync content from a Git repository to update a specified Amazon Web Services resource. Parameters for the sync configuration are determined by the sync type.
687 688 689 690 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 687 def create_sync_configuration(params = {}, = {}) req = build_request(:create_sync_configuration, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Struct
The connection to be deleted.
713 714 715 716 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 713 def delete_connection(params = {}, = {}) req = build_request(:delete_connection, params) req.send_request() end |
#delete_host(params = {}) ⇒ Struct
The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.
741 742 743 744 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 741 def delete_host(params = {}, = {}) req = build_request(:delete_host, params) req.send_request() end |
#delete_repository_link(params = {}) ⇒ Struct
Deletes the association between your connection and a specified external Git repository.
764 765 766 767 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 764 def delete_repository_link(params = {}, = {}) req = build_request(:delete_repository_link, params) req.send_request() end |
#delete_sync_configuration(params = {}) ⇒ Struct
Deletes the sync configuration for a specified repository and connection.
792 793 794 795 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 792 def delete_sync_configuration(params = {}, = {}) req = build_request(:delete_sync_configuration, params) req.send_request() end |
#get_connection(params = {}) ⇒ Types::GetConnectionOutput
Returns the connection ARN and details such as status, owner, and provider type.
826 827 828 829 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 826 def get_connection(params = {}, = {}) req = build_request(:get_connection, params) req.send_request() end |
#get_host(params = {}) ⇒ Types::GetHostOutput
Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.
868 869 870 871 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 868 def get_host(params = {}, = {}) req = build_request(:get_host, params) req.send_request() end |
#get_repository_link(params = {}) ⇒ Types::GetRepositoryLinkOutput
Returns details about a repository link. A repository link allows Git sync to monitor and sync changes from files in a specified Git repository.
904 905 906 907 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 904 def get_repository_link(params = {}, = {}) req = build_request(:get_repository_link, params) req.send_request() end |
#get_repository_sync_status(params = {}) ⇒ Types::GetRepositorySyncStatusOutput
Returns details about the sync status for a repository. A repository sync uses Git sync to push and pull changes from your remote repository.
949 950 951 952 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 949 def get_repository_sync_status(params = {}, = {}) req = build_request(:get_repository_sync_status, params) req.send_request() end |
#get_resource_sync_status(params = {}) ⇒ Types::GetResourceSyncStatusOutput
Returns the status of the sync with the Git repository for a specific Amazon Web Services resource.
1030 1031 1032 1033 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1030 def get_resource_sync_status(params = {}, = {}) req = build_request(:get_resource_sync_status, params) req.send_request() end |
#get_sync_blocker_summary(params = {}) ⇒ Types::GetSyncBlockerSummaryOutput
Returns a list of the most recent sync blockers.
1075 1076 1077 1078 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1075 def get_sync_blocker_summary(params = {}, = {}) req = build_request(:get_sync_blocker_summary, params) req.send_request() end |
#get_sync_configuration(params = {}) ⇒ Types::GetSyncConfigurationOutput
Returns details about a sync configuration, including the sync type and resource name. A sync configuration allows the configuration to sync (push and pull) changes from the remote repository for a specified branch in a Git repository.
1122 1123 1124 1125 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1122 def get_sync_configuration(params = {}, = {}) req = build_request(:get_sync_configuration, params) req.send_request() end |
#list_connections(params = {}) ⇒ Types::ListConnectionsOutput
Lists the connections associated with your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1177 1178 1179 1180 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1177 def list_connections(params = {}, = {}) req = build_request(:list_connections, params) req.send_request() end |
#list_hosts(params = {}) ⇒ Types::ListHostsOutput
Lists the hosts associated with your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1228 1229 1230 1231 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1228 def list_hosts(params = {}, = {}) req = build_request(:list_hosts, params) req.send_request() end |
#list_repository_links(params = {}) ⇒ Types::ListRepositoryLinksOutput
Lists the repository links created for connections in your account.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1273 1274 1275 1276 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1273 def list_repository_links(params = {}, = {}) req = build_request(:list_repository_links, params) req.send_request() end |
#list_repository_sync_definitions(params = {}) ⇒ Types::ListRepositorySyncDefinitionsOutput
Lists the repository sync definitions for repository links in your account.
1314 1315 1316 1317 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1314 def list_repository_sync_definitions(params = {}, = {}) req = build_request(:list_repository_sync_definitions, params) req.send_request() end |
#list_sync_configurations(params = {}) ⇒ Types::ListSyncConfigurationsOutput
Returns a list of sync configurations for a specified repository.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1372 1373 1374 1375 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1372 def list_sync_configurations(params = {}, = {}) req = build_request(:list_sync_configurations, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
Gets the set of key-value pairs (metadata) that are used to manage the resource.
1404 1405 1406 1407 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1404 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.
1437 1438 1439 1440 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1437 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from an Amazon Web Services resource.
1463 1464 1465 1466 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1463 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_host(params = {}) ⇒ Struct
Updates a specified host with the provided configurations.
1500 1501 1502 1503 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1500 def update_host(params = {}, = {}) req = build_request(:update_host, params) req.send_request() end |
#update_repository_link(params = {}) ⇒ Types::UpdateRepositoryLinkOutput
Updates the association between your connection and a specified external Git repository. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.
1548 1549 1550 1551 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1548 def update_repository_link(params = {}, = {}) req = build_request(:update_repository_link, params) req.send_request() end |
#update_sync_blocker(params = {}) ⇒ Types::UpdateSyncBlockerOutput
Allows you to update the status of a sync blocker, resolving the blocker and allowing syncing to continue.
1602 1603 1604 1605 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1602 def update_sync_blocker(params = {}, = {}) req = build_request(:update_sync_blocker, params) req.send_request() end |
#update_sync_configuration(params = {}) ⇒ Types::UpdateSyncConfigurationOutput
Updates the sync configuration for your connection and a specified external Git repository.
1672 1673 1674 1675 |
# File 'gems/aws-sdk-codeconnections/lib/aws-sdk-codeconnections/client.rb', line 1672 def update_sync_configuration(params = {}, = {}) req = build_request(:update_sync_configuration, params) req.send_request() end |