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

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :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`, `:session_token`, and `:account_id` options.

    • ENV, ENV, ENV, and 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::InstanceProfileCredentials` 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)
  • :account_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 —

    When ‘true`, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

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

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the ‘:endpoint` option directly. This is normally constructed from the `:region` option. Configuring `:endpoint` is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :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_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • ‘when_supported` - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` and/or a `requestAlgorithmMember` is modeled.

    • ‘when_required` - When set, a checksum will only be calculated for request payloads of operations modeled with the `httpChecksum` trait where `requestChecksumRequired` is `true` or where a `requestAlgorithmMember` is modeled and supplied.

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

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • ‘when_supported` - (default) When set, checksum validation is performed on all response payloads of operations modeled with the `httpChecksum` trait where `responseAlgorithms` is modeled, except when no modeled checksum algorithms are supported.

    • ‘when_required` - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the `requestValidationModeMember` member is set to `ENABLED`.

  • :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. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default ‘:sigv4a_signing_region_set` is searched for in the following locations:

  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.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.

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

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses ‘NoOpTelemetryProvider` which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the

    ‘opentelemetry-sdk` gem and then, pass in an instance of a `Aws::Telemetry::OTelProvider` for telemetry provider.

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

  • :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_open_timeout (Float) — default: 15 —

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

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

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

  • :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_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a ‘content-length`).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When ‘true`, response errors are raised.

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



473
474
475
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 473

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. 



1761
1762
1763
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1761

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. 



1764
1765
1766
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1764

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: {}) 


1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1734

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  tracer = config.telemetry_provider.tracer_provider.tracer(
    Aws::Telemetry.module_to_tracer_name('Aws::CodeStarconnections')
  )
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config,
    tracer: tracer
  )
  context[:gem_name] = 'aws-sdk-codestarconnections'
  context[:gem_version] = '1.60.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, GitLabSelfManaged
  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:



528
529
530
531
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 528

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, GitLabSelfManaged
  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>) —

    Tags for the host to be created.

Returns:

See Also:



602
603
604
605
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 602

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

Examples:

Request syntax with placeholder values


resp = client.create_repository_link({
  connection_arn: "ConnectionArn", # required
  owner_id: "OwnerId", # required
  repository_name: "RepositoryName", # required
  encryption_key_arn: "KmsKeyArn",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.repository_link_info.connection_arn #=> String
resp.repository_link_info.encryption_key_arn #=> String
resp.repository_link_info.owner_id #=> String
resp.repository_link_info.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.repository_link_info.repository_link_arn #=> String
resp.repository_link_info.repository_link_id #=> String
resp.repository_link_info.repository_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_arn (required, String) —

    The Amazon Resource Name (ARN) of the connection to be associated with the repository link.

  • :owner_id (required, String) —

    The owner ID for the repository associated with a specific sync configuration, such as the owner ID in GitHub.

  • :repository_name (required, String) —

    The name of the repository to be associated with the repository link.

  • :encryption_key_arn (String) —

    The Amazon Resource Name (ARN) encryption key for the repository to be associated with the repository link.

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

    The tags for the repository to be associated with the repository link.

Returns:

See Also:



662
663
664
665
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 662

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

Examples:

Request syntax with placeholder values


resp = client.create_sync_configuration({
  branch: "BranchName", # required
  config_file: "DeploymentFilePath", # required
  repository_link_id: "RepositoryLinkId", # required
  resource_name: "ResourceName", # required
  role_arn: "IamRoleArn", # required
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
  publish_deployment_status: "ENABLED", # accepts ENABLED, DISABLED
  trigger_resource_update_on: "ANY_CHANGE", # accepts ANY_CHANGE, FILE_CHANGE
})

Response structure


resp.sync_configuration.branch #=> String
resp.sync_configuration.config_file #=> String
resp.sync_configuration.owner_id #=> String
resp.sync_configuration.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.sync_configuration.repository_link_id #=> String
resp.sync_configuration.repository_name #=> String
resp.sync_configuration.resource_name #=> String
resp.sync_configuration.role_arn #=> String
resp.sync_configuration.sync_type #=> String, one of "CFN_STACK_SYNC"
resp.sync_configuration.publish_deployment_status #=> String, one of "ENABLED", "DISABLED"
resp.sync_configuration.trigger_resource_update_on #=> String, one of "ANY_CHANGE", "FILE_CHANGE"

Parameters:

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

    ({})

Options Hash (params):

  • :branch (required, String) —

    The branch in the repository from which changes will be synced.

  • :config_file (required, String) —

    The file name of the configuration file that manages syncing between the connection and the repository. This configuration file is stored in the repository.

  • :repository_link_id (required, String) —

    The ID of the repository link created for the connection. A repository link allows Git sync to monitor and sync changes to files in a specified Git repository.

  • :resource_name (required, String) —

    The name of the Amazon Web Services resource (for example, a CloudFormation stack in the case of CFN_STACK_SYNC) that will be synchronized from the linked repository.

  • :role_arn (required, String) —

    The ARN of the IAM role that grants permission for Amazon Web Services to use Git sync to update a given Amazon Web Services resource on your behalf.

  • :sync_type (required, String) —

    The type of sync configuration.

  • :publish_deployment_status (String) —

    Whether to enable or disable publishing of deployment status to source providers.

  • :trigger_resource_update_on (String) —

    When to trigger Git sync to begin the stack update.

Returns:

See Also:



740
741
742
743
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 740

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



766
767
768
769
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 766

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:



794
795
796
797
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 794

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

#delete_repository_link(params = {}) ⇒ Struct

Deletes the association between your connection and a specified external Git repository.

Examples:

Request syntax with placeholder values


resp = client.delete_repository_link({
  repository_link_id: "RepositoryLinkId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :repository_link_id (required, String) —

    The ID of the repository link to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



817
818
819
820
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 817

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

#delete_sync_configuration(params = {}) ⇒ Struct

Deletes the sync configuration for a specified repository and connection.

Examples:

Request syntax with placeholder values


resp = client.delete_sync_configuration({
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
  resource_name: "ResourceName", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :sync_type (required, String) —

    The type of sync configuration to be deleted.

  • :resource_name (required, String) —

    The name of the Amazon Web Services resource associated with the sync configuration to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



845
846
847
848
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 845

def delete_sync_configuration(params = {}, options = {})
  req = build_request(:delete_sync_configuration, 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", "GitLabSelfManaged"
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:



879
880
881
882
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 879

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", "GitLabSelfManaged"
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:



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

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

Examples:

Request syntax with placeholder values


resp = client.get_repository_link({
  repository_link_id: "RepositoryLinkId", # required
})

Response structure


resp.repository_link_info.connection_arn #=> String
resp.repository_link_info.encryption_key_arn #=> String
resp.repository_link_info.owner_id #=> String
resp.repository_link_info.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.repository_link_info.repository_link_arn #=> String
resp.repository_link_info.repository_link_id #=> String
resp.repository_link_info.repository_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :repository_link_id (required, String) —

    The ID of the repository link to get.

Returns:

See Also:



957
958
959
960
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 957

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

Examples:

Request syntax with placeholder values


resp = client.get_repository_sync_status({
  branch: "BranchName", # required
  repository_link_id: "RepositoryLinkId", # required
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
})

Response structure


resp.latest_sync.started_at #=> Time
resp.latest_sync.status #=> String, one of "FAILED", "INITIATED", "IN_PROGRESS", "SUCCEEDED", "QUEUED"
resp.latest_sync.events #=> Array
resp.latest_sync.events[0].event #=> String
resp.latest_sync.events[0].external_id #=> String
resp.latest_sync.events[0].time #=> Time
resp.latest_sync.events[0].type #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :branch (required, String) —

    The branch of the repository link for the requested repository sync status.

  • :repository_link_id (required, String) —

    The repository link ID for the requested repository sync status.

  • :sync_type (required, String) —

    The sync type of the requested sync status.

Returns:

See Also:



1002
1003
1004
1005
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1002

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

Examples:

Request syntax with placeholder values


resp = client.get_resource_sync_status({
  resource_name: "ResourceName", # required
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
})

Response structure


resp.desired_state.branch #=> String
resp.desired_state.directory #=> String
resp.desired_state.owner_id #=> String
resp.desired_state.repository_name #=> String
resp.desired_state.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.desired_state.sha #=> String
resp.latest_successful_sync.events #=> Array
resp.latest_successful_sync.events[0].event #=> String
resp.latest_successful_sync.events[0].external_id #=> String
resp.latest_successful_sync.events[0].time #=> Time
resp.latest_successful_sync.events[0].type #=> String
resp.latest_successful_sync.initial_revision.branch #=> String
resp.latest_successful_sync.initial_revision.directory #=> String
resp.latest_successful_sync.initial_revision.owner_id #=> String
resp.latest_successful_sync.initial_revision.repository_name #=> String
resp.latest_successful_sync.initial_revision.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.latest_successful_sync.initial_revision.sha #=> String
resp.latest_successful_sync.started_at #=> Time
resp.latest_successful_sync.status #=> String, one of "FAILED", "INITIATED", "IN_PROGRESS", "SUCCEEDED"
resp.latest_successful_sync.target_revision.branch #=> String
resp.latest_successful_sync.target_revision.directory #=> String
resp.latest_successful_sync.target_revision.owner_id #=> String
resp.latest_successful_sync.target_revision.repository_name #=> String
resp.latest_successful_sync.target_revision.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.latest_successful_sync.target_revision.sha #=> String
resp.latest_successful_sync.target #=> String
resp.latest_sync.events #=> Array
resp.latest_sync.events[0].event #=> String
resp.latest_sync.events[0].external_id #=> String
resp.latest_sync.events[0].time #=> Time
resp.latest_sync.events[0].type #=> String
resp.latest_sync.initial_revision.branch #=> String
resp.latest_sync.initial_revision.directory #=> String
resp.latest_sync.initial_revision.owner_id #=> String
resp.latest_sync.initial_revision.repository_name #=> String
resp.latest_sync.initial_revision.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.latest_sync.initial_revision.sha #=> String
resp.latest_sync.started_at #=> Time
resp.latest_sync.status #=> String, one of "FAILED", "INITIATED", "IN_PROGRESS", "SUCCEEDED"
resp.latest_sync.target_revision.branch #=> String
resp.latest_sync.target_revision.directory #=> String
resp.latest_sync.target_revision.owner_id #=> String
resp.latest_sync.target_revision.repository_name #=> String
resp.latest_sync.target_revision.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.latest_sync.target_revision.sha #=> String
resp.latest_sync.target #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :resource_name (required, String) —

    The name of the Amazon Web Services resource for the sync status with the Git repository.

  • :sync_type (required, String) —

    The sync type for the sync status with the Git repository.

Returns:

See Also:



1083
1084
1085
1086
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1083

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

#get_sync_blocker_summary(params = {}) ⇒ Types::GetSyncBlockerSummaryOutput

Returns a list of the most recent sync blockers.

Examples:

Request syntax with placeholder values


resp = client.get_sync_blocker_summary({
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
  resource_name: "ResourceName", # required
})

Response structure


resp.sync_blocker_summary.resource_name #=> String
resp.sync_blocker_summary.parent_resource_name #=> String
resp.sync_blocker_summary.latest_blockers #=> Array
resp.sync_blocker_summary.latest_blockers[0].id #=> String
resp.sync_blocker_summary.latest_blockers[0].type #=> String, one of "AUTOMATED"
resp.sync_blocker_summary.latest_blockers[0].status #=> String, one of "ACTIVE", "RESOLVED"
resp.sync_blocker_summary.latest_blockers[0].created_reason #=> String
resp.sync_blocker_summary.latest_blockers[0].created_at #=> Time
resp.sync_blocker_summary.latest_blockers[0].contexts #=> Array
resp.sync_blocker_summary.latest_blockers[0].contexts[0].key #=> String
resp.sync_blocker_summary.latest_blockers[0].contexts[0].value #=> String
resp.sync_blocker_summary.latest_blockers[0].resolved_reason #=> String
resp.sync_blocker_summary.latest_blockers[0].resolved_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :sync_type (required, String) —

    The sync type for the sync blocker summary.

  • :resource_name (required, String) —

    The name of the Amazon Web Services resource currently blocked from automatically being synced from a Git repository.

Returns:

See Also:



1128
1129
1130
1131
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1128

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

Examples:

Request syntax with placeholder values


resp = client.get_sync_configuration({
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
  resource_name: "ResourceName", # required
})

Response structure


resp.sync_configuration.branch #=> String
resp.sync_configuration.config_file #=> String
resp.sync_configuration.owner_id #=> String
resp.sync_configuration.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.sync_configuration.repository_link_id #=> String
resp.sync_configuration.repository_name #=> String
resp.sync_configuration.resource_name #=> String
resp.sync_configuration.role_arn #=> String
resp.sync_configuration.sync_type #=> String, one of "CFN_STACK_SYNC"
resp.sync_configuration.publish_deployment_status #=> String, one of "ENABLED", "DISABLED"
resp.sync_configuration.trigger_resource_update_on #=> String, one of "ANY_CHANGE", "FILE_CHANGE"

Parameters:

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

    ({})

Options Hash (params):

  • :sync_type (required, String) —

    The sync type for the sync configuration for which you want to retrieve information.

  • :resource_name (required, String) —

    The name of the Amazon Web Services resource for the sync configuration for which you want to retrieve information.

Returns:

See Also:



1175
1176
1177
1178
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1175

def get_sync_configuration(params = {}, options = {})
  req = build_request(:get_sync_configuration, 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, GitLabSelfManaged
  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", "GitLabSelfManaged"
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:



1230
1231
1232
1233
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1230

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", "GitLabSelfManaged"
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:



1281
1282
1283
1284
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1281

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

Examples:

Request syntax with placeholder values


resp = client.list_repository_links({
  max_results: 1,
  next_token: "SharpNextToken",
})

Response structure


resp.repository_links #=> Array
resp.repository_links[0].connection_arn #=> String
resp.repository_links[0].encryption_key_arn #=> String
resp.repository_links[0].owner_id #=> String
resp.repository_links[0].provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.repository_links[0].repository_link_arn #=> String
resp.repository_links[0].repository_link_id #=> String
resp.repository_links[0].repository_name #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    A non-zero, non-negative integer used to limit the number of returned results.

  • :next_token (String) —

    An enumeration token that, when provided in a request, returns the next batch of the results.

Returns:

See Also:



1326
1327
1328
1329
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1326

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

#list_repository_sync_definitions(params = {}) ⇒ Types::ListRepositorySyncDefinitionsOutput

Lists the repository sync definitions for repository links in your account.

Examples:

Request syntax with placeholder values


resp = client.list_repository_sync_definitions({
  repository_link_id: "RepositoryLinkId", # required
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
})

Response structure


resp.repository_sync_definitions #=> Array
resp.repository_sync_definitions[0].branch #=> String
resp.repository_sync_definitions[0].directory #=> String
resp.repository_sync_definitions[0].parent #=> String
resp.repository_sync_definitions[0].target #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :repository_link_id (required, String) —

    The ID of the repository link for the sync definition for which you want to retrieve information.

  • :sync_type (required, String) —

    The sync type of the repository link for the the sync definition for which you want to retrieve information.

Returns:

See Also:



1367
1368
1369
1370
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1367

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

Examples:

Request syntax with placeholder values


resp = client.list_sync_configurations({
  max_results: 1,
  next_token: "SharpNextToken",
  repository_link_id: "RepositoryLinkId", # required
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
})

Response structure


resp.sync_configurations #=> Array
resp.sync_configurations[0].branch #=> String
resp.sync_configurations[0].config_file #=> String
resp.sync_configurations[0].owner_id #=> String
resp.sync_configurations[0].provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.sync_configurations[0].repository_link_id #=> String
resp.sync_configurations[0].repository_name #=> String
resp.sync_configurations[0].resource_name #=> String
resp.sync_configurations[0].role_arn #=> String
resp.sync_configurations[0].sync_type #=> String, one of "CFN_STACK_SYNC"
resp.sync_configurations[0].publish_deployment_status #=> String, one of "ENABLED", "DISABLED"
resp.sync_configurations[0].trigger_resource_update_on #=> String, one of "ANY_CHANGE", "FILE_CHANGE"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    A non-zero, non-negative integer used to limit the number of returned results.

  • :next_token (String) —

    An enumeration token that allows the operation to batch the results of the operation.

  • :repository_link_id (required, String) —

    The ID of the repository link for the requested list of sync configurations.

  • :sync_type (required, String) —

    The sync type for the requested list of sync configurations.

Returns:

See Also:



1425
1426
1427
1428
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1425

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



1457
1458
1459
1460
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1457

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:



1490
1491
1492
1493
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1490

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:



1516
1517
1518
1519
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1516

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:



1553
1554
1555
1556
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1553

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

Examples:

Request syntax with placeholder values


resp = client.update_repository_link({
  connection_arn: "ConnectionArn",
  encryption_key_arn: "KmsKeyArn",
  repository_link_id: "RepositoryLinkId", # required
})

Response structure


resp.repository_link_info.connection_arn #=> String
resp.repository_link_info.encryption_key_arn #=> String
resp.repository_link_info.owner_id #=> String
resp.repository_link_info.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.repository_link_info.repository_link_arn #=> String
resp.repository_link_info.repository_link_id #=> String
resp.repository_link_info.repository_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_arn (String) —

    The Amazon Resource Name (ARN) of the connection for the repository link to be updated. The updated connection ARN must have the same providerType (such as GitHub) as the original connection ARN for the repo link.

  • :encryption_key_arn (String) —

    The Amazon Resource Name (ARN) of the encryption key for the repository link to be updated.

  • :repository_link_id (required, String) —

    The ID of the repository link to be updated.

Returns:

See Also:



1601
1602
1603
1604
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1601

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

Examples:

Request syntax with placeholder values


resp = client.update_sync_blocker({
  id: "Id", # required
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
  resource_name: "ResourceName", # required
  resolved_reason: "ResolvedReason", # required
})

Response structure


resp.resource_name #=> String
resp.parent_resource_name #=> String
resp.sync_blocker.id #=> String
resp.sync_blocker.type #=> String, one of "AUTOMATED"
resp.sync_blocker.status #=> String, one of "ACTIVE", "RESOLVED"
resp.sync_blocker.created_reason #=> String
resp.sync_blocker.created_at #=> Time
resp.sync_blocker.contexts #=> Array
resp.sync_blocker.contexts[0].key #=> String
resp.sync_blocker.contexts[0].value #=> String
resp.sync_blocker.resolved_reason #=> String
resp.sync_blocker.resolved_at #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the sync blocker to be updated.

  • :sync_type (required, String) —

    The sync type of the sync blocker to be updated.

  • :resource_name (required, String) —

    The name of the resource for the sync blocker to be updated.

  • :resolved_reason (required, String) —

    The reason for resolving the sync blocker.

Returns:

See Also:



1655
1656
1657
1658
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1655

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

#update_sync_configuration(params = {}) ⇒ Types::UpdateSyncConfigurationOutput

Updates the sync configuration for your connection and a specified external Git repository.

Examples:

Request syntax with placeholder values


resp = client.update_sync_configuration({
  branch: "BranchName",
  config_file: "DeploymentFilePath",
  repository_link_id: "RepositoryLinkId",
  resource_name: "ResourceName", # required
  role_arn: "IamRoleArn",
  sync_type: "CFN_STACK_SYNC", # required, accepts CFN_STACK_SYNC
  publish_deployment_status: "ENABLED", # accepts ENABLED, DISABLED
  trigger_resource_update_on: "ANY_CHANGE", # accepts ANY_CHANGE, FILE_CHANGE
})

Response structure


resp.sync_configuration.branch #=> String
resp.sync_configuration.config_file #=> String
resp.sync_configuration.owner_id #=> String
resp.sync_configuration.provider_type #=> String, one of "Bitbucket", "GitHub", "GitHubEnterpriseServer", "GitLab", "GitLabSelfManaged"
resp.sync_configuration.repository_link_id #=> String
resp.sync_configuration.repository_name #=> String
resp.sync_configuration.resource_name #=> String
resp.sync_configuration.role_arn #=> String
resp.sync_configuration.sync_type #=> String, one of "CFN_STACK_SYNC"
resp.sync_configuration.publish_deployment_status #=> String, one of "ENABLED", "DISABLED"
resp.sync_configuration.trigger_resource_update_on #=> String, one of "ANY_CHANGE", "FILE_CHANGE"

Parameters:

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

    ({})

Options Hash (params):

  • :branch (String) —

    The branch for the sync configuration to be updated.

  • :config_file (String) —

    The configuration file for the sync configuration to be updated.

  • :repository_link_id (String) —

    The ID of the repository link for the sync configuration to be updated.

  • :resource_name (required, String) —

    The name of the Amazon Web Services resource for the sync configuration to be updated.

  • :role_arn (String) —

    The ARN of the IAM role for the sync configuration to be updated.

  • :sync_type (required, String) —

    The sync type for the sync configuration to be updated.

  • :publish_deployment_status (String) —

    Whether to enable or disable publishing of deployment status to source providers.

  • :trigger_resource_update_on (String) —

    When to trigger Git sync to begin the stack update.

Returns:

See Also:



1725
1726
1727
1728
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1725

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


1754
1755
1756
 
# File 'lib/aws-sdk-codestarconnections/client.rb', line 1754

def waiter_names
  []
end