Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/CodeStarconnections/Client.html below:

Client — AWS SDK for Ruby V2

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

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.

You can configure a default region in the following locations:

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

Go here for a list of supported regions.

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:

• Aws::Credentials
• SharedCredentials
• InstanceProfileCredentials
• AssumeRoleCredentials

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

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.

#config, #handlers

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

  Constructs an API client.

• #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.

• #create_host(options = {}) ⇒ Types::CreateHostOutput

  Creates a resource that represents the infrastructure where a third-party provider is installed.

• #delete_connection(options = {}) ⇒ Struct

  The connection to be deleted.

  .

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

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

  .

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

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

  .

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

  Lists the connections associated with your account.

  .

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

  Lists the hosts associated with your account.

  .

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

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

  .

• #tag_resource(options = {}) ⇒ Struct

  Adds to or modifies the tags of the given resource.

• #untag_resource(options = {}) ⇒ Struct

  Removes tags from an AWS resource.

  .

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

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

• #waiter_names ⇒ Array<Symbol>

  Returns the list of supported waiters.

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

#handle, #handle_request, #handle_response

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.

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.

The connection to be deleted.

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.

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

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

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

Removes tags from an AWS resource.

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

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)

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

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

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

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

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4