Class: Aws::CodeStar::Client

Inherits:
Seahorse::Client::Base show all
Includes:
Aws::ClientStubs
Defined in:
gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb

Overview

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.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from Aws::ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

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

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

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

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

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

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

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

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

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

    • Aws.config[: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. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] 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:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

  • :client_side_monitoring (Boolean) — default: false —

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

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

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

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

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

  • :client_side_monitoring_port (Integer) — default: 31000 —

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

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

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

  • :convert_params (Boolean) — default: true —

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

  • :correct_clock_skew (Boolean) — default: true —

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

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

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

  • :disable_host_prefix_injection (Boolean) — default: false —

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

  • :disable_request_compression (Boolean) — default: false —

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

  • :endpoint (String) —

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

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

  • :request_min_compression_size_bytes (Integer) — default: 10240 —

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

  • :retry_backoff (Proc) —

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

    @see https://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/. It should have a maximum length of 50.

  • :secret_access_key (String)
  • :session_token (String)
  • :simple_json (Boolean) — default: false —

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

    When :simple_json is enabled, the request parameters hash must be formatted exactly as the DynamoDB API expects.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling 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.

  • :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::CodeStar::EndpointProvider) —

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

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

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_open_timeout (Float) — default: 15 —

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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



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

def initialize(*args)
  super
end

Instance Method Details

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

Parameters:

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

    ({})

Options Hash (params):

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



446
447
448
449
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 446

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

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

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.

Examples:

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",
  },
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

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

  • :id (required, String) —

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

  • :description (String) —

    The description of the project, if any.

  • :client_request_token (String) —

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

  • :source_code (Array<Types::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.

  • :toolchain (Types::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.

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

    The tags created for the project.

Returns:

See Also:



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

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

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

Parameters:

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

    ({})

Options Hash (params):

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



608
609
610
611
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 608

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

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

Parameters:

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

    ({})

Options Hash (params):

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



654
655
656
657
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 654

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :user_arn (required, String) —

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

Returns:

See Also:



686
687
688
689
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 686

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

#describe_project(params = {}) ⇒ 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
resp.status.state #=> String
resp.status.reason #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The ID of the project.

Returns:

See Also:



731
732
733
734
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 731

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

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

Parameters:

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

    ({})

Options Hash (params):

  • :user_arn (required, String) —

    The Amazon Resource Name (ARN) of the user.

Returns:

See Also:



770
771
772
773
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 770

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

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

Parameters:

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

    ({})

Options Hash (params):

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



802
803
804
805
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 802

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

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

Parameters:

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

    ({})

Options Hash (params):

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



840
841
842
843
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 840

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

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

Parameters:

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

    ({})

Options Hash (params):

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



881
882
883
884
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 881

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

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

Parameters:

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

    ({})

Options Hash (params):

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



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

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

#list_team_members(params = {}) ⇒ 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 #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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



962
963
964
965
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 962

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

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

Parameters:

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

    ({})

Options Hash (params):

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



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

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

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

Parameters:

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

    ({})

Options Hash (params):

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



1037
1038
1039
1040
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1037

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

#untag_project(params = {}) ⇒ Struct

Removes tags from a project.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



1063
1064
1065
1066
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1063

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

#update_project(params = {}) ⇒ Struct

Updates a project in AWS CodeStar.

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



1093
1094
1095
1096
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1093

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

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

Parameters:

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

    ({})

Options Hash (params):

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



1149
1150
1151
1152
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1149

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

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

Parameters:

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

    ({})

Options Hash (params):

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



1208
1209
1210
1211
 
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 1208

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