Class: Aws::CodeStarconnections::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
Aws::ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV to true.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :disable_request_compression (Boolean) — default: false —

    When set to ‘true’ the request body will not be compressed for supported operations.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

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

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/<sdk_ua_app_id>. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :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 ClientStubs#stub_responses. See ClientStubs for more information.

    ** Please note ** When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

    • ‘Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an access token generated from `aws login`.

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::CodeStarconnections::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::CodeStarconnections::EndpointParameters`

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



395
396
397
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 395

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



918
919
920
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 918

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



921
922
923
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 921

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


896
897
898
899
900
901
902
903
904
905
906
907
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 896

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-codestarconnections'
  context[:gem_version] = '1.35.0'
  Seahorse::Client::Request.new(handlers, context)
end

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

Examples:

Request syntax with placeholder values


resp = client.create_connection({
  provider_type: "Bitbucket", # accepts Bitbucket, GitHub, GitHubEnterpriseServer, GitLab
  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

Parameters:

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

    ({})

Options Hash (params):

  • :provider_type (String) —

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

  • :connection_name (required, String) —

    The name of the connection to be created.

  • :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:



450
451
452
453
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 450

def create_connection(params = {}, options = {})
  req = build_request(:create_connection, params)
  req.send_request(options)
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.

<note markdown=“1”> 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.

</note>

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the host to be created.

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

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

Returns:

See Also:



523
524
525
526
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 523

def create_host(params = {}, options = {})
  req = build_request(:create_host, params)
  req.send_request(options)
end

#delete_connection(params = {}) ⇒ Struct

The connection to be deleted.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :connection_arn (required, String) —

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

    <note markdown=“1”> The ARN is never reused if the connection is deleted.

    </note>

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



549
550
551
552
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 549

def delete_connection(params = {}, options = {})
  req = build_request(:delete_connection, params)
  req.send_request(options)
end

#delete_host(params = {}) ⇒ Struct

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

<note markdown=“1”> A host cannot be deleted if it is in the VPC_CONFIG_INITIALIZING or VPC_CONFIG_DELETING state.

</note>

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :host_arn (required, String) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



577
578
579
580
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 577

def delete_host(params = {}, options = {})
  req = build_request(:delete_host, params)
  req.send_request(options)
end

#get_connection(params = {}) ⇒ 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", "GitLab"
resp.connection. #=> String
resp.connection.connection_status #=> String, one of "PENDING", "AVAILABLE", "ERROR"
resp.connection.host_arn #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_arn (required, String) —

    The Amazon Resource Name (ARN) of a connection.

Returns:

See Also:



611
612
613
614
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 611

def get_connection(params = {}, options = {})
  req = build_request(:get_connection, params)
  req.send_request(options)
end

#get_host(params = {}) ⇒ 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", "GitLab"
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

Parameters:

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

    ({})

Options Hash (params):

  • :host_arn (required, String) —

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

Returns:

See Also:



653
654
655
656
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 653

def get_host(params = {}, options = {})
  req = build_request(:get_host, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


resp = client.list_connections({
  provider_type_filter: "Bitbucket", # accepts Bitbucket, GitHub, GitHubEnterpriseServer, GitLab
  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", "GitLab"
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



708
709
710
711
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 708

def list_connections(params = {}, options = {})
  req = build_request(:list_connections, params)
  req.send_request(options)
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.

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", "GitLab"
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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



759
760
761
762
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 759

def list_hosts(params = {}, options = {})
  req = build_request(:list_hosts, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ 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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



791
792
793
794
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 791

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



824
825
826
827
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 824

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes tags from an Amazon Web Services resource.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

  • :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:



850
851
852
853
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 850

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_host(params = {}) ⇒ Struct

Updates a specified host with the provided configurations.

Examples:

Request syntax with placeholder values


resp = client.update_host({
  host_arn: "HostArn", # required
  provider_endpoint: "Url",
  vpc_configuration: {
    vpc_id: "VpcId", # required
    subnet_ids: ["SubnetId"], # required
    security_group_ids: ["SecurityGroupId"], # required
    tls_certificate: "TlsCertificate",
  },
})

Parameters:

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

    ({})

Options Hash (params):

  • :host_arn (required, String) —

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

  • :provider_endpoint (String) —

    The URL or endpoint of the host to be updated.

  • :vpc_configuration (Types::VpcConfiguration) —

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

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



887
888
889
890
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 887

def update_host(params = {}, options = {})
  req = build_request(:update_host, params)
  req.send_request(options)
end

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


911
912
913
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 911

def waiter_names
  []
end