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

Class: Aws::CodeStar::Client

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

Overview

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

codestar = Aws::CodeStar::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

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

Region

You can configure a default region in the following locations:

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

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

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

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

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

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

Constructs an API client.

Options Hash (options):

  • :access_key_id (String)

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

  • :convert_params (Boolean) — default: true

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

  • :credentials (required, Credentials)

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

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

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

  • :http_continue_timeout (Float) — default: 1

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

  • :http_idle_timeout (Integer) — default: 5

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

  • :http_open_timeout (Integer) — default: 15

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

  • :http_proxy (String)

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

  • :http_read_timeout (Integer) — default: 60

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

  • :http_wire_trace (Boolean) — default: false

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

  • :log_level (Symbol) — default: :info

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

  • :log_formatter (Logging::LogFormatter)

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

  • :logger (Logger) — default: nil

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

  • :profile (String)

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

  • :raise_response_errors (Boolean) — default: true

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

  • :region (required, String)

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

  • :retry_limit (Integer) — default: 3

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

  • :secret_access_key (String)

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

  • :session_token (String)

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

  • :simple_json (Boolean) — default: false

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

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

  • :ssl_ca_bundle (String)

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

  • :ssl_ca_directory (String)

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

  • :ssl_ca_store (String)

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

  • :ssl_verify_peer (Boolean) — default: true

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

  • :stub_responses (Boolean) — default: false

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

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

  • :validate_params (Boolean) — default: true

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

Instance Method Details

#associate_team_member(options = {}) ⇒ Types::AssociateTeamMemberResult

Adds an IAM user to the team for an AWS CodeStar project.

Examples:

Request syntax with placeholder values


resp = client.associate_team_member({
  project_id: "ProjectId", # required
  client_request_token: "ClientRequestToken",
  user_arn: "UserArn", # required
  project_role: "Role", # required
  remote_access_allowed: false,
})

Response structure


resp.client_request_token #=> String

Options Hash (options):

  • :project_id (required, String)

    The ID of the project to which you will add the IAM user.

  • :client_request_token (String)

    A user- or system-generated token that identifies the entity that requested the team member association to the project. This token can be used to repeat the request.

  • :user_arn (required, String)

    The Amazon Resource Name (ARN) for the IAM user you want to add to the AWS CodeStar project.

  • :project_role (required, String)

    The AWS CodeStar project role that will apply to this user. This role determines what actions a user can take in an AWS CodeStar project.

  • :remote_access_allowed (Boolean)

    Whether the team member is allowed to use an SSH public/private key pair to remotely access project resources, for example Amazon EC2 instances.

Returns:

See Also:

#create_project(options = {}) ⇒ Types::CreateProjectResult

Reserved for future use. To create a project, use the AWS CodeStar console.

Examples:

Request syntax with placeholder values


resp = client.create_project({
  name: "ProjectName", # required
  id: "ProjectId", # required
  description: "ProjectDescription",
  client_request_token: "ClientRequestToken",
})

Response structure


resp.id #=> String
resp.arn #=> String
resp.client_request_token #=> String
resp.project_template_id #=> String

Options Hash (options):

  • :name (required, String)

    Reserved for future use.

  • :id (required, String)

    Reserved for future use.

  • :description (String)

    Reserved for future use.

  • :client_request_token (String)

    Reserved for future use.

Returns:

See Also:

#create_user_profile(options = {}) ⇒ Types::CreateUserProfileResult

Creates a profile for a user that includes user preferences, such as the display name and email address assocciated with the user, in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

Examples:

Request syntax with placeholder values


resp = client.({
  user_arn: "UserArn", # required
  display_name: "UserProfileDisplayName", # required
  email_address: "Email", # required
  ssh_public_key: "SshPublicKey",
})

Response structure


resp.user_arn #=> String
resp.display_name #=> String
resp.email_address #=> String
resp.ssh_public_key #=> String
resp.created_timestamp #=> Time
resp.last_modified_timestamp #=> Time

Options Hash (options):

  • :user_arn (required, String)

    The Amazon Resource Name (ARN) of the user in IAM.

  • :display_name (required, String)

    The name that will be displayed as the friendly name for the user in AWS CodeStar.

  • :email_address (required, String)

    The email address that will be displayed as part of the user\'s profile in AWS CodeStar.

  • :ssh_public_key (String)

    The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user\'s private key for SSH access.

Returns:

See Also:

#delete_project(options = {}) ⇒ Types::DeleteProjectResult

Deletes a project, including project resources. Does not delete users associated with the project, but does delete the IAM roles that allowed access to the project.

Examples:

Request syntax with placeholder values


resp = client.delete_project({
  id: "ProjectId", # required
  client_request_token: "ClientRequestToken",
  delete_stack: false,
})

Response structure


resp.stack_id #=> String
resp.project_arn #=> String

Options Hash (options):

  • :id (required, String)

    The ID of the project to be deleted in AWS CodeStar.

  • :client_request_token (String)

    A user- or system-generated token that identifies the entity that requested project deletion. This token can be used to repeat the request.

  • :delete_stack (Boolean)

    Whether to send a delete request for the primary stack in AWS CloudFormation originally used to generate the project and its resources. This option will delete all AWS resources for the project (except for any buckets in Amazon S3) as well as deleting the project itself. Recommended for most use cases.

Returns:

See Also:

#delete_user_profile(options = {}) ⇒ Types::DeleteUserProfileResult

Deletes a user profile in AWS CodeStar, including all personal preference data associated with that profile, such as display name and email address. It does not delete the history of that user, for example the history of commits made by that user.

Examples:

Request syntax with placeholder values


resp = client.({
  user_arn: "UserArn", # required
})

Response structure


resp.user_arn #=> String

Options Hash (options):

  • :user_arn (required, String)

    The Amazon Resource Name (ARN) of the user to delete from AWS CodeStar.

Returns:

See Also:

#describe_project(options = {}) ⇒ Types::DescribeProjectResult

Describes a project and its resources.

Examples:

Request syntax with placeholder values


resp = client.describe_project({
  id: "ProjectId", # required
})

Response structure


resp.name #=> String
resp.id #=> String
resp.arn #=> String
resp.description #=> String
resp.client_request_token #=> String
resp.created_time_stamp #=> Time
resp.stack_id #=> String
resp.project_template_id #=> String

Options Hash (options):

  • :id (required, String)

    The ID of the project.

Returns:

See Also:

#describe_user_profile(options = {}) ⇒ Types::DescribeUserProfileResult

Describes a user in AWS CodeStar and the user attributes across all projects.

Examples:

Request syntax with placeholder values


resp = client.({
  user_arn: "UserArn", # required
})

Response structure


resp.user_arn #=> String
resp.display_name #=> String
resp.email_address #=> String
resp.ssh_public_key #=> String
resp.created_timestamp #=> Time
resp.last_modified_timestamp #=> Time

Options Hash (options):

  • :user_arn (required, String)

    The Amazon Resource Name (ARN) of the user.

Returns:

See Also:

#disassociate_team_member(options = {}) ⇒ Struct

Removes a user from a project. Removing a user from a project also removes the IAM policies from that user that allowed access to the project and its resources. Disassociating a team member does not remove that user's profile from AWS CodeStar. It does not remove the user from IAM.

Examples:

Request syntax with placeholder values


resp = client.disassociate_team_member({
  project_id: "ProjectId", # required
  user_arn: "UserArn", # required
})

Options Hash (options):

  • :project_id (required, String)

    The ID of the AWS CodeStar project from which you want to remove a team member.

  • :user_arn (required, String)

    The Amazon Resource Name (ARN) of the IAM user or group whom you want to remove from the project.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#list_projects(options = {}) ⇒ Types::ListProjectsResult

Lists all projects in AWS CodeStar associated with your AWS account.

Examples:

Request syntax with placeholder values


resp = client.list_projects({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.projects #=> Array
resp.projects[0].project_id #=> String
resp.projects[0].project_arn #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String)

    The continuation token to be used to return the next set of results, if the results cannot be returned in one response.

  • :max_results (Integer)

    The maximum amount of data that can be contained in a single set of results.

Returns:

See Also:

#list_resources(options = {}) ⇒ Types::ListResourcesResult

Lists resources associated with a project in AWS CodeStar.

Examples:

Request syntax with placeholder values


resp = client.list_resources({
  project_id: "ProjectId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.resources #=> Array
resp.resources[0].id #=> String
resp.next_token #=> String

Options Hash (options):

  • :project_id (required, String)

    The ID of the project.

  • :next_token (String)

    The continuation token for the next set of results, if the results cannot be returned in one response.

  • :max_results (Integer)

    The maximum amount of data that can be contained in a single set of results.

Returns:

See Also:

#list_tags_for_project(options = {}) ⇒ Types::ListTagsForProjectResult

Gets the tags for a project.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_project({
  id: "ProjectId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String
resp.next_token #=> String

Options Hash (options):

  • :id (required, String)

    The ID of the project to get tags for.

  • :next_token (String)

    Reserved for future use.

  • :max_results (Integer)

    Reserved for future use.

Returns:

See Also:

#list_team_members(options = {}) ⇒ Types::ListTeamMembersResult

Lists all team members associated with a project.

Examples:

Request syntax with placeholder values


resp = client.list_team_members({
  project_id: "ProjectId", # required
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.team_members #=> Array
resp.team_members[0].user_arn #=> String
resp.team_members[0].project_role #=> String
resp.team_members[0].remote_access_allowed #=> true/false
resp.next_token #=> String

Options Hash (options):

  • :project_id (required, String)

    The ID of the project for which you want to list team members.

  • :next_token (String)

    The continuation token for the next set of results, if the results cannot be returned in one response.

  • :max_results (Integer)

    The maximum number of team members you want returned in a response.

Returns:

See Also:

#list_user_profiles(options = {}) ⇒ Types::ListUserProfilesResult

Lists all the user profiles configured for your AWS account in AWS CodeStar.

Examples:

Request syntax with placeholder values


resp = client.list_user_profiles({
  next_token: "PaginationToken",
  max_results: 1,
})

Response structure


resp.user_profiles #=> Array
resp.user_profiles[0].user_arn #=> String
resp.user_profiles[0].display_name #=> String
resp.user_profiles[0].email_address #=> String
resp.user_profiles[0].ssh_public_key #=> String
resp.next_token #=> String

Options Hash (options):

  • :next_token (String)

    The continuation token for the next set of results, if the results cannot be returned in one response.

  • :max_results (Integer)

    The maximum number of results to return in a response.

Returns:

See Also:

#tag_project(options = {}) ⇒ Types::TagProjectResult

Adds tags to a project.

Examples:

Request syntax with placeholder values


resp = client.tag_project({
  id: "ProjectId", # required
  tags: { # required
    "TagKey" => "TagValue",
  },
})

Response structure


resp.tags #=> Hash
resp.tags["TagKey"] #=> String

Options Hash (options):

  • :id (required, String)

    The ID of the project you want to add a tag to.

  • :tags (required, Hash<String,String>)

    The tags you want to add to the project.

Returns:

See Also:

#untag_project(options = {}) ⇒ Struct

Removes tags from a project.

Examples:

Request syntax with placeholder values


resp = client.untag_project({
  id: "ProjectId", # required
  tags: ["TagKey"], # required
})

Options Hash (options):

  • :id (required, String)

    The ID of the project to remove tags from.

  • :tags (required, Array<String>)

    The tags to remove from the project.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_project(options = {}) ⇒ Struct

Updates a project in AWS CodeStar.

Examples:

Request syntax with placeholder values


resp = client.update_project({
  id: "ProjectId", # required
  name: "ProjectName",
  description: "ProjectDescription",
})

Options Hash (options):

  • :id (required, String)

    The ID of the project you want to update.

  • :name (String)

    The name of the project you want to update.

  • :description (String)

    The description of the project, if any.

Returns:

  • (Struct)

    Returns an empty response.

See Also:

#update_team_member(options = {}) ⇒ Types::UpdateTeamMemberResult

Updates a team member's attributes in an AWS CodeStar project. For example, you can change a team member's role in the project, or change whether they have remote access to project resources.

Examples:

Request syntax with placeholder values


resp = client.update_team_member({
  project_id: "ProjectId", # required
  user_arn: "UserArn", # required
  project_role: "Role",
  remote_access_allowed: false,
})

Response structure


resp.user_arn #=> String
resp.project_role #=> String
resp.remote_access_allowed #=> true/false

Options Hash (options):

  • :project_id (required, String)

    The ID of the project.

  • :user_arn (required, String)

    The Amazon Resource Name (ARN) of the user for whom you want to change team membership attributes.

  • :project_role (String)

    The role assigned to the user in the project. Project roles have different levels of access. For more information, see Working with Teams in the AWS CodeStar User Guide.

  • :remote_access_allowed (Boolean)

    Whether a team member is allowed to remotely access project resources using the SSH public key associated with the user\'s profile. Even if this is set to True, the user must associate a public key with their profile before the user can access resources.

Returns:

See Also:

#update_user_profile(options = {}) ⇒ Types::UpdateUserProfileResult

Updates a user's profile in AWS CodeStar. The user profile is not project-specific. Information in the user profile is displayed wherever the user's information appears to other users in AWS CodeStar.

Examples:

Request syntax with placeholder values


resp = client.({
  user_arn: "UserArn", # required
  display_name: "UserProfileDisplayName",
  email_address: "Email",
  ssh_public_key: "SshPublicKey",
})

Response structure


resp.user_arn #=> String
resp.display_name #=> String
resp.email_address #=> String
resp.ssh_public_key #=> String
resp.created_timestamp #=> Time
resp.last_modified_timestamp #=> Time

Options Hash (options):

  • :user_arn (required, String)

    The name that will be displayed as the friendly name for the user in AWS CodeStar.

  • :display_name (String)

    The name that is displayed as the friendly name for the user in AWS CodeStar.

  • :email_address (String)

    The email address that is displayed as part of the user\'s profile in AWS CodeStar.

  • :ssh_public_key (String)

    The SSH public key associated with the user in AWS CodeStar. If a project owner allows the user remote access to project resources, this public key will be used along with the user\'s private key for SSH access.

Returns:

See Also:

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

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

Basic Usage

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

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

Configuration

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

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

Callbacks

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

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

  # disable max attempts
  w.max_attempts = nil

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

end

Handling Errors

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

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

Parameters:

  • waiter_name (Symbol)

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

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

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

Yield Parameters:

Returns:

  • (Boolean)

    Returns true if the waiter was successful.

Raises:

  • (Errors::FailureStateError)

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

  • (Errors::TooManyAttemptsError)

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

  • (Errors::UnexpectedError)

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

  • (Errors::NoSuchWaiterError)

    Raised when you request to wait for an unknown state.

#waiter_namesArray<Symbol>

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

Waiter NameClient MethodDefault Delay:Default Max Attempts:

Returns:

  • (Array<Symbol>)

    the list of supported waiters.