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

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

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(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



183
184
185
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 183

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:



234
235
236
237
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 234

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

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

Parameters:

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

    ({})

Options Hash (params):

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



281
282
283
284
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 281

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:



340
341
342
343
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 340

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:



386
387
388
389
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 386

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:



418
419
420
421
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 418

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

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String)

    The ID of the project.

Returns:

See Also:



460
461
462
463
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 460

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:



499
500
501
502
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 499

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:



531
532
533
534
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 531

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:



569
570
571
572
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 569

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:



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

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:



649
650
651
652
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 649

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:



691
692
693
694
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 691

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:



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

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:



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

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:



792
793
794
795
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 792

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:



822
823
824
825
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 822

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:



878
879
880
881
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 878

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:



937
938
939
940
# File 'gems/aws-sdk-codestar/lib/aws-sdk-codestar/client.rb', line 937

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