class Aws::CodeStar::Client

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

client = Aws::CodeStar::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.

Attributes

identifier[R]

@api private

Public Class Methods

errors_module() click to toggle source

@api private

# File lib/aws-sdk-codestar/client.rb, line 1181
def errors_module
  Errors
end
new(*args) click to toggle source

@overload initialize(options)

@param [Hash] options
@option options [required, Aws::CredentialProvider] :credentials
  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[:credentials]`
  * The `:access_key_id`, `:secret_access_key`, and `:session_token` options.
  * ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
  * `~/.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.

@option options [required, String] :region
  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:

  * `Aws.config[:region]`
  * `ENV['AWS_REGION']`
  * `ENV['AMAZON_REGION']`
  * `ENV['AWS_DEFAULT_REGION']`
  * `~/.aws/credentials`
  * `~/.aws/config`

@option options [String] :access_key_id

@option options [Boolean] :active_endpoint_cache (false)
  When set to `true`, a thread polling for endpoints will be running in
  the background every 60 secs (default). Defaults to `false`.

@option options [Boolean] :adaptive_retry_wait_to_fill (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.

@option options [Boolean] :client_side_monitoring (false)
  When `true`, client-side metrics will be collected for all API requests from
  this client.

@option options [String] :client_side_monitoring_client_id ("")
  Allows you to provide an identifier for this client which will be attached to
  all generated client side metrics. Defaults to an empty string.

@option options [String] :client_side_monitoring_host ("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.

@option options [Integer] :client_side_monitoring_port (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.

@option options [Aws::ClientSideMonitoring::Publisher] :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher)
  Allows you to provide a custom client-side monitoring publisher class. By default,
  will use the Client Side Monitoring Agent Publisher.

@option options [Boolean] :convert_params (true)
  When `true`, an attempt is made to coerce request parameters into
  the required types.

@option options [Boolean] :correct_clock_skew (true)
  Used only in `standard` and adaptive retry modes. Specifies whether to apply
  a clock skew correction and retry requests with skewed client clocks.

@option options [Boolean] :disable_host_prefix_injection (false)
  Set to true to disable SDK automatically adding host prefix
  to default service endpoint when available.

@option options [String] :endpoint
  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.

@option options [Integer] :endpoint_cache_max_entries (1000)
  Used for the maximum size limit of the LRU cache storing endpoints data
  for endpoint discovery enabled operations. Defaults to 1000.

@option options [Integer] :endpoint_cache_max_threads (10)
  Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

@option options [Integer] :endpoint_cache_poll_interval (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.

@option options [Boolean] :endpoint_discovery (false)
  When set to `true`, endpoint discovery will be enabled for operations when available.

@option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
  The log formatter.

@option options [Symbol] :log_level (:info)
  The log level to send messages to the `:logger` at.

@option options [Logger] :logger
  The Logger instance to send log messages to.  If this option
  is not set, logging will be disabled.

@option options [Integer] :max_attempts (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.

@option options [String] :profile ("default")
  Used when loading credentials from the shared credentials file
  at HOME/.aws/credentials.  When not specified, 'default' is used.

@option options [Proc] :retry_backoff
  A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
  This option is only used in the `legacy` retry mode.

@option options [Float] :retry_base_delay (0.3)
  The base delay in seconds used by the default backoff function. This option
  is only used in the `legacy` retry mode.

@option options [Symbol] :retry_jitter (: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 https://www.awsarchitectureblog.com/2015/03/backoff.html

@option options [Integer] :retry_limit (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.

@option options [Integer] :retry_max_delay (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.

@option options [String] :retry_mode ("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.

@option options [String] :secret_access_key

@option options [String] :session_token

@option options [Boolean] :simple_json (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.

@option options [Boolean] :stub_responses (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.

@option options [Boolean] :validate_params (true)
  When `true`, request parameters are validated before
  sending the request.

@option options [URI::HTTP,String] :http_proxy A proxy to send
  requests through.  Formatted like 'http://proxy.com:123'.

@option options [Float] :http_open_timeout (15) The number of
  seconds to wait when opening a HTTP session before raising a
  `Timeout::Error`.

@option options [Integer] :http_read_timeout (60) The default
  number of seconds to wait for response data.  This value can
  safely be set per-request on the session.

@option options [Float] :http_idle_timeout (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.

@option options [Float] :http_continue_timeout (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.

@option options [Boolean] :http_wire_trace (false) When `true`,
  HTTP debug output will be sent to the `:logger`.

@option options [Boolean] :ssl_verify_peer (true) When `true`,
  SSL peer certificates are verified when establishing a
  connection.

@option options [String] :ssl_ca_bundle 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.

@option options [String] :ssl_ca_directory 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.
Calls superclass method
# File lib/aws-sdk-codestar/client.rb, line 334
def initialize(*args)
  super
end

Public Instance Methods

associate_team_member(params = {}, options = {}) click to toggle source

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

@option params [required, String] :project_id

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

@option params [String] :client_request_token

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.

@option params [required, String] :user_arn

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

@option params [required, String] :project_role

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.

@option params [Boolean] :remote_access_allowed

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

@return [Types::AssociateTeamMemberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::AssociateTeamMemberResult#client_request_token #client_request_token} => String

@example 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,
})

@example Response structure

resp.client_request_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/AssociateTeamMember AWS API Documentation

@overload associate_team_member(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 385
def associate_team_member(params = {}, options = {})
  req = build_request(:associate_team_member, params)
  req.send_request(options)
end
build_request(operation_name, params = {}) click to toggle source

@param params ({}) @api private

# File lib/aws-sdk-codestar/client.rb, line 1156
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-codestar'
  context[:gem_version] = '1.32.0'
  Seahorse::Client::Request.new(handlers, context)
end
create_project(params = {}, options = {}) click to toggle source

Creates a project, including project resources. This action creates a project based on a submitted project request. A set of source code files and a toolchain template file can be included with the project request. If these are not provided, an empty project is created.

@option params [required, String] :name

The display name for the project to be created in AWS CodeStar.

@option params [required, String] :id

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

@option params [String] :description

The description of the project, if any.

@option params [String] :client_request_token

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

@option params [Array<Types::Code>] :source_code

A list of the Code objects submitted with the project request. If this
parameter is specified, the request must also include the toolchain
parameter.

@option params [Types::Toolchain] :toolchain

The name of the toolchain template file submitted with the project
request. If this parameter is specified, the request must also include
the sourceCode parameter.

@option params [Hash<String,String>] :tags

The tags created for the project.

@return [Types::CreateProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateProjectResult#id #id} => String
* {Types::CreateProjectResult#arn #arn} => String
* {Types::CreateProjectResult#client_request_token #client_request_token} => String
* {Types::CreateProjectResult#project_template_id #project_template_id} => String

@example Request syntax with placeholder values

resp = client.create_project({
  name: "ProjectName", # required
  id: "ProjectId", # required
  description: "ProjectDescription",
  client_request_token: "ClientRequestToken",
  source_code: [
    {
      source: { # required
        s3: { # required
          bucket_name: "BucketName",
          bucket_key: "BucketKey",
        },
      },
      destination: { # required
        code_commit: {
          name: "RepositoryName", # required
        },
        git_hub: {
          name: "RepositoryName", # required
          description: "RepositoryDescription",
          type: "RepositoryType", # required
          owner: "RepositoryOwner", # required
          private_repository: false, # required
          issues_enabled: false, # required
          token: "GitHubPersonalToken", # required
        },
      },
    },
  ],
  toolchain: {
    source: { # required
      s3: { # required
        bucket_name: "BucketName",
        bucket_key: "BucketKey",
      },
    },
    role_arn: "RoleArn",
    stack_parameters: {
      "TemplateParameterKey" => "TemplateParameterValue",
    },
  },
  tags: {
    "TagKey" => "TagValue",
  },
})

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateProject AWS API Documentation

@overload create_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 488
def create_project(params = {}, options = {})
  req = build_request(:create_project, params)
  req.send_request(options)
end
create_user_profile(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :user_arn

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

@option params [required, String] :display_name

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

@option params [required, String] :email_address

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

@option params [String] :ssh_public_key

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.

@return [Types::CreateUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::CreateUserProfileResult#user_arn #user_arn} => String
* {Types::CreateUserProfileResult#display_name #display_name} => String
* {Types::CreateUserProfileResult#email_address #email_address} => String
* {Types::CreateUserProfileResult#ssh_public_key #ssh_public_key} => String
* {Types::CreateUserProfileResult#created_timestamp #created_timestamp} => Time
* {Types::CreateUserProfileResult#last_modified_timestamp #last_modified_timestamp} => Time

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/CreateUserProfile AWS API Documentation

@overload create_user_profile(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 547
def create_user_profile(params = {}, options = {})
  req = build_request(:create_user_profile, params)
  req.send_request(options)
end
delete_project(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :id

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

@option params [String] :client_request_token

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

@option params [Boolean] :delete_stack

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.

@return [Types::DeleteProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DeleteProjectResult#stack_id #stack_id} => String
* {Types::DeleteProjectResult#project_arn #project_arn} => String

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteProject AWS API Documentation

@overload delete_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 593
def delete_project(params = {}, options = {})
  req = build_request(:delete_project, params)
  req.send_request(options)
end
delete_user_profile(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :user_arn

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

@return [Types::DeleteUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DeleteUserProfileResult#user_arn #user_arn} => String

@example Request syntax with placeholder values

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

@example Response structure

resp.user_arn #=> String

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DeleteUserProfile AWS API Documentation

@overload delete_user_profile(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 625
def delete_user_profile(params = {}, options = {})
  req = build_request(:delete_user_profile, params)
  req.send_request(options)
end
describe_project(params = {}, options = {}) click to toggle source

Describes a project and its resources.

@option params [required, String] :id

The ID of the project.

@return [Types::DescribeProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeProjectResult#name #name} => String
* {Types::DescribeProjectResult#id #id} => String
* {Types::DescribeProjectResult#arn #arn} => String
* {Types::DescribeProjectResult#description #description} => String
* {Types::DescribeProjectResult#client_request_token #client_request_token} => String
* {Types::DescribeProjectResult#created_time_stamp #created_time_stamp} => Time
* {Types::DescribeProjectResult#stack_id #stack_id} => String
* {Types::DescribeProjectResult#project_template_id #project_template_id} => String
* {Types::DescribeProjectResult#status #status} => Types::ProjectStatus

@example Request syntax with placeholder values

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

@example 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
resp.status.state #=> String
resp.status.reason #=> String

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeProject AWS API Documentation

@overload describe_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 670
def describe_project(params = {}, options = {})
  req = build_request(:describe_project, params)
  req.send_request(options)
end
describe_user_profile(params = {}, options = {}) click to toggle source

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

@option params [required, String] :user_arn

The Amazon Resource Name (ARN) of the user.

@return [Types::DescribeUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::DescribeUserProfileResult#user_arn #user_arn} => String
* {Types::DescribeUserProfileResult#display_name #display_name} => String
* {Types::DescribeUserProfileResult#email_address #email_address} => String
* {Types::DescribeUserProfileResult#ssh_public_key #ssh_public_key} => String
* {Types::DescribeUserProfileResult#created_timestamp #created_timestamp} => Time
* {Types::DescribeUserProfileResult#last_modified_timestamp #last_modified_timestamp} => Time

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DescribeUserProfile AWS API Documentation

@overload describe_user_profile(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 709
def describe_user_profile(params = {}, options = {})
  req = build_request(:describe_user_profile, params)
  req.send_request(options)
end
disassociate_team_member(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :project_id

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

@option params [required, String] :user_arn

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

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/DisassociateTeamMember AWS API Documentation

@overload disassociate_team_member(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 741
def disassociate_team_member(params = {}, options = {})
  req = build_request(:disassociate_team_member, params)
  req.send_request(options)
end
list_projects(params = {}, options = {}) click to toggle source

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

@option params [String] :next_token

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

@option params [Integer] :max_results

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

@return [Types::ListProjectsResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListProjectsResult#projects #projects} => Array&lt;Types::ProjectSummary&gt;
* {Types::ListProjectsResult#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListProjects AWS API Documentation

@overload list_projects(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 779
def list_projects(params = {}, options = {})
  req = build_request(:list_projects, params)
  req.send_request(options)
end
list_resources(params = {}, options = {}) click to toggle source

Lists resources associated with a project in AWS CodeStar.

@option params [required, String] :project_id

The ID of the project.

@option params [String] :next_token

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

@option params [Integer] :max_results

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

@return [Types::ListResourcesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListResourcesResult#resources #resources} => Array&lt;Types::Resource&gt;
* {Types::ListResourcesResult#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListResources AWS API Documentation

@overload list_resources(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 820
def list_resources(params = {}, options = {})
  req = build_request(:list_resources, params)
  req.send_request(options)
end
list_tags_for_project(params = {}, options = {}) click to toggle source

Gets the tags for a project.

@option params [required, String] :id

The ID of the project to get tags for.

@option params [String] :next_token

Reserved for future use.

@option params [Integer] :max_results

Reserved for future use.

@return [Types::ListTagsForProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListTagsForProjectResult#tags #tags} => Hash&lt;String,String&gt;
* {Types::ListTagsForProjectResult#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTagsForProject AWS API Documentation

@overload list_tags_for_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 859
def list_tags_for_project(params = {}, options = {})
  req = build_request(:list_tags_for_project, params)
  req.send_request(options)
end
list_team_members(params = {}, options = {}) click to toggle source

Lists all team members associated with a project.

@option params [required, String] :project_id

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

@option params [String] :next_token

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

@option params [Integer] :max_results

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

@return [Types::ListTeamMembersResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListTeamMembersResult#team_members #team_members} => Array&lt;Types::TeamMember&gt;
* {Types::ListTeamMembersResult#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example 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 #=> Boolean
resp.next_token #=> String

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListTeamMembers AWS API Documentation

@overload list_team_members(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 901
def list_team_members(params = {}, options = {})
  req = build_request(:list_team_members, params)
  req.send_request(options)
end
list_user_profiles(params = {}, options = {}) click to toggle source

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

@option params [String] :next_token

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

@option params [Integer] :max_results

The maximum number of results to return in a response.

@return [Types::ListUserProfilesResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::ListUserProfilesResult#user_profiles #user_profiles} => Array&lt;Types::UserProfileSummary&gt;
* {Types::ListUserProfilesResult#next_token #next_token} => String

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/ListUserProfiles AWS API Documentation

@overload list_user_profiles(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 941
def list_user_profiles(params = {}, options = {})
  req = build_request(:list_user_profiles, params)
  req.send_request(options)
end
tag_project(params = {}, options = {}) click to toggle source

Adds tags to a project.

@option params [required, String] :id

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

@option params [required, Hash<String,String>] :tags

The tags you want to add to the project.

@return [Types::TagProjectResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::TagProjectResult#tags #tags} => Hash&lt;String,String&gt;

@example Request syntax with placeholder values

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

@example Response structure

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/TagProject AWS API Documentation

@overload tag_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 976
def tag_project(params = {}, options = {})
  req = build_request(:tag_project, params)
  req.send_request(options)
end
untag_project(params = {}, options = {}) click to toggle source

Removes tags from a project.

@option params [required, String] :id

The ID of the project to remove tags from.

@option params [required, Array<String>] :tags

The tags to remove from the project.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UntagProject AWS API Documentation

@overload untag_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 1002
def untag_project(params = {}, options = {})
  req = build_request(:untag_project, params)
  req.send_request(options)
end
update_project(params = {}, options = {}) click to toggle source

Updates a project in AWS CodeStar.

@option params [required, String] :id

The ID of the project you want to update.

@option params [String] :name

The name of the project you want to update.

@option params [String] :description

The description of the project, if any.

@return [Struct] Returns an empty {Seahorse::Client::Response response}.

@example Request syntax with placeholder values

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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateProject AWS API Documentation

@overload update_project(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 1032
def update_project(params = {}, options = {})
  req = build_request(:update_project, params)
  req.send_request(options)
end
update_team_member(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :project_id

The ID of the project.

@option params [required, String] :user_arn

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

@option params [String] :project_role

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

[1]: http://docs.aws.amazon.com/codestar/latest/userguide/working-with-teams.html

@option params [Boolean] :remote_access_allowed

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.

@return [Types::UpdateTeamMemberResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateTeamMemberResult#user_arn #user_arn} => String
* {Types::UpdateTeamMemberResult#project_role #project_role} => String
* {Types::UpdateTeamMemberResult#remote_access_allowed #remote_access_allowed} => Boolean

@example 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,
})

@example Response structure

resp.user_arn #=> String
resp.project_role #=> String
resp.remote_access_allowed #=> Boolean

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateTeamMember AWS API Documentation

@overload update_team_member(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 1088
def update_team_member(params = {}, options = {})
  req = build_request(:update_team_member, params)
  req.send_request(options)
end
update_user_profile(params = {}, options = {}) click to toggle source

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.

@option params [required, String] :user_arn

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

@option params [String] :display_name

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

@option params [String] :email_address

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

@option params [String] :ssh_public_key

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.

@return [Types::UpdateUserProfileResult] Returns a {Seahorse::Client::Response response} object which responds to the following methods:

* {Types::UpdateUserProfileResult#user_arn #user_arn} => String
* {Types::UpdateUserProfileResult#display_name #display_name} => String
* {Types::UpdateUserProfileResult#email_address #email_address} => String
* {Types::UpdateUserProfileResult#ssh_public_key #ssh_public_key} => String
* {Types::UpdateUserProfileResult#created_timestamp #created_timestamp} => Time
* {Types::UpdateUserProfileResult#last_modified_timestamp #last_modified_timestamp} => Time

@example Request syntax with placeholder values

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

@example 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

@see docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19/UpdateUserProfile AWS API Documentation

@overload update_user_profile(params = {}) @param [Hash] params ({})

# File lib/aws-sdk-codestar/client.rb, line 1147
def update_user_profile(params = {}, options = {})
  req = build_request(:update_user_profile, params)
  req.send_request(options)
end
waiter_names() click to toggle source

@api private @deprecated

# File lib/aws-sdk-codestar/client.rb, line 1171
def waiter_names
  []
end