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 AWS 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.
-
#delete_connection(params = {}) ⇒ Struct
The connection to be deleted.
-
#delete_host(params = {}) ⇒ Struct
The host to be deleted.
-
#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.
-
#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_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 AWS resource.
-
#update_host(params = {}) ⇒ Struct
Updates a specified host with the provided configurations.
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.
334 335 336 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 334 def initialize(*args) super end |
Instance Method Details
#create_connection(params = {}) ⇒ Types::CreateConnectionOutput
Creates a connection that can then be given to other AWS 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.
390 391 392 393 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 390 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.
452 453 454 455 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 452 def create_host(params = {}, = {}) req = build_request(:create_host, params) req.send_request() end |
#delete_connection(params = {}) ⇒ Struct
The connection to be deleted.
478 479 480 481 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 478 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.
506 507 508 509 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 506 def delete_host(params = {}, = {}) req = build_request(:delete_host, params) req.send_request() end |
#get_connection(params = {}) ⇒ Types::GetConnectionOutput
Returns the connection ARN and details such as status, owner, and provider type.
540 541 542 543 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 540 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.
582 583 584 585 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 582 def get_host(params = {}, = {}) req = build_request(:get_host, 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.
637 638 639 640 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 637 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.
688 689 690 691 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 688 def list_hosts(params = {}, = {}) req = build_request(:list_hosts, 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.
720 721 722 723 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 720 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.
753 754 755 756 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 753 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from an AWS resource.
779 780 781 782 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 779 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.
816 817 818 819 |
# File 'gems/aws-sdk-codestarconnections/lib/aws-sdk-codestarconnections/client.rb', line 816 def update_host(params = {}, = {}) req = build_request(:update_host, params) req.send_request() end |