Class: Aws::CodeStarconnections::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::CodeStarconnections::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb
Overview
An API client for CodeStarconnections. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::CodeStarconnections::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.
395 396 397 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 395 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.
450 451 452 453 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 450 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.
524 525 526 527 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 524 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.
584 585 586 587 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 584 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.
662 663 664 665 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 662 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.
688 689 690 691 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 688 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.
716 717 718 719 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 716 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.
739 740 741 742 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 739 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.
767 768 769 770 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 767 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.
801 802 803 804 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 801 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.
843 844 845 846 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 843 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.
879 880 881 882 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 879 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.
924 925 926 927 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 924 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.
1005 1006 1007 1008 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1005 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.
1050 1051 1052 1053 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1050 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.
1097 1098 1099 1100 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1097 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.
1152 1153 1154 1155 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1152 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.
1203 1204 1205 1206 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1203 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.
1248 1249 1250 1251 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1248 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.
1289 1290 1291 1292 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1289 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.
1347 1348 1349 1350 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1347 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.
1379 1380 1381 1382 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1379 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.
1412 1413 1414 1415 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1412 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.
1438 1439 1440 1441 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1438 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.
1475 1476 1477 1478 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1475 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.
1523 1524 1525 1526 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1523 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.
1577 1578 1579 1580 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1577 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.
1647 1648 1649 1650 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 1647 def update_sync_configuration(params = {}, = {}) req = build_request(:update_sync_configuration, params) req.send_request() end |