You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CodeStarconnections::Client

Inherits:
Seahorse::Client::Base show all
Defined in:
(unknown)

Overview

An API client for AWS CodeStar connections. To construct a client, you need to configure a :region and :credentials.

codestarconnections = Aws::CodeStarconnections::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

  • ENV['AWS_REGION']
  • Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

  • ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
  • Aws.config[:credentials]
  • The shared credentials ini file at ~/.aws/credentials (more information)
  • From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::CodeStarconnections::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options = {}) ⇒ Aws::CodeStarconnections::Client

Constructs an API client.

Options Hash (options):

  • :access_key_id (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :active_endpoint_cache (Boolean) —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types. See Plugins::ParamConverter for more details.

  • :credentials (required, Credentials) —

    Your AWS credentials. The following locations will be searched in order for credentials:

    • :access_key_id, :secret_access_key, and :session_token options
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • HOME/.aws/credentials shared credentials file
    • EC2 instance profile credentials See Plugins::RequestSigner for more details.
  • :disable_host_prefix_injection (Boolean) —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available. See Plugins::EndpointPattern for more details.

  • :endpoint (String) —

    A default endpoint is constructed from the :region. See Plugins::RegionalEndpoint for more details.

  • :endpoint_cache_max_entries (Integer) —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_max_threads (Integer) —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10. See Plugins::EndpointDiscovery for more details.

  • :endpoint_cache_poll_interval (Integer) —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

  • :endpoint_discovery (Boolean) —

    When set to true, endpoint discovery will be enabled for operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

  • :http_continue_timeout (Float) — default: 1 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_idle_timeout (Integer) — default: 5 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_open_timeout (Integer) — default: 15 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_proxy (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_read_timeout (Integer) — default: 60 —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :http_wire_trace (Boolean) — default: false —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the logger at. See Plugins::Logging for more details.

  • :log_formatter (Logging::LogFormatter) —

    The log formatter. Defaults to Seahorse::Client::Logging::Formatter.default. See Plugins::Logging for more details.

  • :logger (Logger) — default: nil —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled. See Plugins::Logging for more details.

  • :profile (String) —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used. See Plugins::RequestSigner for more details.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised. See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

  • :region (required, String) —

    The AWS region to connect to. The region is used to construct the client endpoint. Defaults to ENV['AWS_REGION']. Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors and auth errors from expired credentials. See Plugins::RetryErrors for more details.

  • :secret_access_key (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :session_token (String) —

    Used to set credentials statically. See Plugins::RequestSigner for more details.

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disable response data type conversions. This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects. See Plugins::Protocols::JsonRpc for more details.

  • :ssl_ca_bundle (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_directory (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_ca_store (String) —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :ssl_verify_peer (Boolean) — default: true —

    See Seahorse::Client::Plugins::NetHttp for more details.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling Aws::ClientStubs#stub_responses. See Aws::ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled. See Plugins::StubResponses for more details.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

#create_connection(options = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  provider_type: "Bitbucket", # accepts Bitbucket, GitHub, GitHubEnterpriseServer
  connection_name: "ConnectionName", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  host_arn: "HostArn",
})

Response structure


resp.connection_arn #=> String
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :provider_type (String) —

    The name of the external provider where your third-party code repository is configured. The valid provider type is Bitbucket.

  • :connection_name (required, String) —

    The name of the connection to be created. The name must be unique in the calling AWS account.

  • :tags (Array<Types::Tag>) —

    The key-value pair to use when tagging the resource.

  • :host_arn (String) —

    The Amazon Resource Name (ARN) of the host associated with the connection to be created.

Returns:

See Also:

#create_host(options = {}) ⇒ 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.

A host created through the CLI or the SDK is in PENDING status by default. You can make its status AVAILABLE by setting up the host in the console.

Examples:

Request syntax with placeholder values


resp = client.create_host({
  name: "HostName", # required
  provider_type: "Bitbucket", # required, accepts Bitbucket, GitHub, GitHubEnterpriseServer
  provider_endpoint: "Url", # required
  vpc_configuration: {
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
    security_group_ids: ["SecurityGroupId"], # required
    tls_certificate: "TlsCertificate",
  },
})

Response structure


resp.host_arn #=> String

Options Hash (options):

  • :name (required, String) —

    The name of the host to be created. The name must be unique in the calling AWS account.

  • :provider_type (required, String) —

    The name of the installed provider to be associated with your connection. The host resource represents the infrastructure where your provider type is installed. The valid provider type is GitHub Enterprise Server.

  • :provider_endpoint (required, String) —

    The endpoint of the infrastructure to be represented by the host after it is created.

  • :vpc_configuration (Types::VpcConfiguration) —

    The VPC configuration to be provisioned for the host. A VPC must be configured and the infrastructure to be represented by the host must already be connected to the VPC.

Returns:

See Also:

#delete_connection(options = {}) ⇒ Struct

The connection to be deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_connection({
  connection_arn: "ConnectionArn", # required
})

Options Hash (options):

  • :connection_arn (required, String) —

    The Amazon Resource Name (ARN) of the connection to be deleted.

    The ARN is never reused if the connection is deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#delete_host(options = {}) ⇒ Struct

The host to be deleted. Before you delete a host, all connections associated to the host must be deleted.

A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

Examples:

Request syntax with placeholder values


resp = client.delete_host({
  host_arn: "HostArn", # required
})

Options Hash (options):

  • :host_arn (required, String) —

    The Amazon Resource Name (ARN) of the host to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#get_connection(options = {}) ⇒ Types::GetConnectionOutput

Returns the connection ARN and details such as status, owner, and provider type.

Examples:

Request syntax with placeholder values


resp = client.get_connection({
  connection_arn: "ConnectionArn", # required
})

Response structure


resp.connection.connection_name #=> String
resp.connection.connection_arn #=> String
resp.connection.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer"
resp.connection. #=> String
resp.connection.connection_status #=> String, one of "PENDING", "AVAILABLE", "ERROR"
resp.connection.host_arn #=> String

Options Hash (options):

  • :connection_arn (required, String) —

    The Amazon Resource Name (ARN) of a connection.

Returns:

See Also:

#get_host(options = {}) ⇒ Types::GetHostOutput

Returns the host ARN and details such as status, provider type, endpoint, and, if applicable, the VPC configuration.

Examples:

Request syntax with placeholder values


resp = client.get_host({
  host_arn: "HostArn", # required
})

Response structure


resp.name #=> String
resp.status #=> String
resp.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer"
resp.provider_endpoint #=> String
resp.vpc_configuration.vpc_id #=> String
resp.vpc_configuration.subnet_ids #=> Array
resp.vpc_configuration.subnet_ids[0] #=> String
resp.vpc_configuration.security_group_ids #=> Array
resp.vpc_configuration.security_group_ids[0] #=> String
resp.vpc_configuration.tls_certificate #=> String

Options Hash (options):

  • :host_arn (required, String) —

    The Amazon Resource Name (ARN) of the requested host.

Returns:

See Also:

#list_connections(options = {}) ⇒ Types::ListConnectionsOutput

Lists the connections associated with your account.

Examples:

Request syntax with placeholder values


resp = client.list_connections({
  provider_type_filter: "Bitbucket", # accepts Bitbucket, GitHub, GitHubEnterpriseServer
  host_arn_filter: "HostArn",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connections #=> Array
resp.connections[0].connection_name #=> String
resp.connections[0].connection_arn #=> String
resp.connections[0].provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer"
resp.connections[0]. #=> String
resp.connections[0].connection_status #=> String, one of "PENDING", "AVAILABLE", "ERROR"
resp.connections[0].host_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :provider_type_filter (String) —

    Filters the list of connections to those associated with a specified provider, such as Bitbucket.

  • :host_arn_filter (String) —

    Filters the list of connections to those associated with a specified host.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token that was returned from the previous ListConnections call, which can be used to return the next set of connections in the list.

Returns:

See Also:

#list_hosts(options = {}) ⇒ Types::ListHostsOutput

Lists the hosts associated with your account.

Examples:

Request syntax with placeholder values


resp = client.list_hosts({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.hosts #=> Array
resp.hosts[0].name #=> String
resp.hosts[0].host_arn #=> String
resp.hosts[0].provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer"
resp.hosts[0].provider_endpoint #=> String
resp.hosts[0].vpc_configuration.vpc_id #=> String
resp.hosts[0].vpc_configuration.subnet_ids #=> Array
resp.hosts[0].vpc_configuration.subnet_ids[0] #=> String
resp.hosts[0].vpc_configuration.security_group_ids #=> Array
resp.hosts[0].vpc_configuration.security_group_ids[0] #=> String
resp.hosts[0].vpc_configuration.tls_certificate #=> String
resp.hosts[0].status #=> String
resp.hosts[0].status_message #=> String
resp.next_token #=> String

Options Hash (options):

  • :max_results (Integer) —

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned nextToken value.

  • :next_token (String) —

    The token that was returned from the previous ListHosts call, which can be used to return the next set of hosts in the list.

Returns:

See Also:

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceOutput

Gets the set of key-value pairs (metadata) that are used to manage the resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "AmazonResourceName", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which you want to get information about tags, if any.

Returns:

See Also:

#tag_resource(options = {}) ⇒ Struct

Adds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "AmazonResourceName", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to which you want to add or update tags.

  • :tags (required, Array<Types::Tag>) —

    The tags you want to modify or add to the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#untag_resource(options = {}) ⇒ Struct

Removes tags from an AWS resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "AmazonResourceName", # required
  tag_keys: ["TagKey"], # required
})

Options Hash (options):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to remove tags from.

  • :tag_keys (required, Array<String>) —

    The list of keys for the tags to be removed from the resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end

Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end

Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end

Parameters:

  • waiter_name (Symbol) —

    The name of the waiter. See #waiter_names for a full list of supported waiters.

  • params (Hash) (defaults to: {}) —

    Additional request parameters. See the #waiter_names for a list of supported waiters and what request they call. The called request determines the list of accepted parameters.

Yield Parameters:

Returns:

  • (Boolean) —

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError) —

    Raised when the waiter terminates because the waiter has entered a state that it will not transition out of, preventing success.

  • (Errors::TooManyAttemptsError) —

    Raised when the configured maximum number of attempts have been made, and the waiter is not yet successful.

  • (Errors::UnexpectedError) —

    Raised when an error is encounted while polling for a resource that is not expected.

  • (Errors::NoSuchWaiterError) —

    Raised when you request to wait for an unknown state.

#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>) —

    the list of supported waiters.