/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeStar

NAME

Paws::CodeStar - Perl Interface to AWS AWS CodeStar

SYNOPSIS

use Paws;

my $obj = Paws->service('CodeStar');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS CodeStar

This is the API reference for AWS CodeStar. This reference provides descriptions of the operations and data types for the AWS CodeStar API along with usage examples.

You can use the AWS CodeStar API to work with:

Projects and their resources, by calling the following:

  • DeleteProject, which deletes a project.

  • DescribeProject, which lists the attributes of a project.

  • ListProjects, which lists all projects associated with your AWS account.

  • ListResources, which lists the resources associated with a project.

  • ListTagsForProject, which lists the tags associated with a project.

  • TagProject, which adds tags to a project.

  • UntagProject, which removes tags from a project.

  • UpdateProject, which updates the attributes of a project.

Teams and team members, by calling the following:

  • AssociateTeamMember, which adds an IAM user to the team for a project.

  • DisassociateTeamMember, which removes an IAM user from the team for a project.

  • ListTeamMembers, which lists all the IAM users in the team for a project, including their roles and attributes.

  • UpdateTeamMember, which updates a team member's attributes in a project.

Users, by calling the following:

  • CreateUserProfile, which creates a user profile that contains data associated with the user across all projects.

  • DeleteUserProfile, which deletes all user profile information across all projects.

  • DescribeUserProfile, which describes the profile of a user.

  • ListUserProfiles, which lists all user profiles.

  • UpdateUserProfile, which updates the profile for a user.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codestar-2017-04-19

METHODS

AssociateTeamMember

ProjectId => Str
ProjectRole => Str
UserArn => Str
[ClientRequestToken => Str]
[RemoteAccessAllowed => Bool]

Each argument is described in detail in: Paws::CodeStar::AssociateTeamMember

Returns: a Paws::CodeStar::AssociateTeamMemberResult instance

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

CreateProject

Id => Str
Name => Str
[ClientRequestToken => Str]
[Description => Str]
[SourceCode => ArrayRef[Paws::CodeStar::Code]]
[Tags => Paws::CodeStar::Tags]
[Toolchain => Paws::CodeStar::Toolchain]

Each argument is described in detail in: Paws::CodeStar::CreateProject

Returns: a Paws::CodeStar::CreateProjectResult instance

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.

CreateUserProfile

DisplayName => Str
EmailAddress => Str
UserArn => Str
[SshPublicKey => Str]

Each argument is described in detail in: Paws::CodeStar::CreateUserProfile

Returns: a Paws::CodeStar::CreateUserProfileResult instance

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.

DeleteProject

Id => Str
[ClientRequestToken => Str]
[DeleteStack => Bool]

Each argument is described in detail in: Paws::CodeStar::DeleteProject

Returns: a Paws::CodeStar::DeleteProjectResult instance

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.

DeleteUserProfile

UserArn => Str

Each argument is described in detail in: Paws::CodeStar::DeleteUserProfile

Returns: a Paws::CodeStar::DeleteUserProfileResult instance

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.

DescribeProject

Id => Str

Each argument is described in detail in: Paws::CodeStar::DescribeProject

Returns: a Paws::CodeStar::DescribeProjectResult instance

Describes a project and its resources.

DescribeUserProfile

UserArn => Str

Each argument is described in detail in: Paws::CodeStar::DescribeUserProfile

Returns: a Paws::CodeStar::DescribeUserProfileResult instance

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

DisassociateTeamMember

ProjectId => Str
UserArn => Str

Each argument is described in detail in: Paws::CodeStar::DisassociateTeamMember

Returns: a Paws::CodeStar::DisassociateTeamMemberResult instance

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.

ListProjects

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeStar::ListProjects

Returns: a Paws::CodeStar::ListProjectsResult instance

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

ListResources

ProjectId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeStar::ListResources

Returns: a Paws::CodeStar::ListResourcesResult instance

Lists resources associated with a project in AWS CodeStar.

ListTagsForProject

Id => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeStar::ListTagsForProject

Returns: a Paws::CodeStar::ListTagsForProjectResult instance

Gets the tags for a project.

ListTeamMembers

ProjectId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeStar::ListTeamMembers

Returns: a Paws::CodeStar::ListTeamMembersResult instance

Lists all team members associated with a project.

ListUserProfiles

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::CodeStar::ListUserProfiles

Returns: a Paws::CodeStar::ListUserProfilesResult instance

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

TagProject

Id => Str
Tags => Paws::CodeStar::Tags

Each argument is described in detail in: Paws::CodeStar::TagProject

Returns: a Paws::CodeStar::TagProjectResult instance

Adds tags to a project.

UntagProject

Id => Str
Tags => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeStar::UntagProject

Returns: a Paws::CodeStar::UntagProjectResult instance

Removes tags from a project.

UpdateProject

Id => Str
[Description => Str]
[Name => Str]

Each argument is described in detail in: Paws::CodeStar::UpdateProject

Returns: a Paws::CodeStar::UpdateProjectResult instance

Updates a project in AWS CodeStar.

UpdateTeamMember

ProjectId => Str
UserArn => Str
[ProjectRole => Str]
[RemoteAccessAllowed => Bool]

Each argument is described in detail in: Paws::CodeStar::UpdateTeamMember

Returns: a Paws::CodeStar::UpdateTeamMemberResult instance

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.

UpdateUserProfile

UserArn => Str
[DisplayName => Str]
[EmailAddress => Str]
[SshPublicKey => Str]

Each argument is described in detail in: Paws::CodeStar::UpdateUserProfile

Returns: a Paws::CodeStar::UpdateUserProfileResult instance

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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllProjects(sub { },[MaxResults => Int, NextToken => Str])

ListAllProjects([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- projects, passing the object as the first parameter, and the string 'projects' as the second parameter

If not, it will return a a Paws::CodeStar::ListProjectsResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllResources(sub { },ProjectId => Str, [MaxResults => Int, NextToken => Str])

ListAllResources(ProjectId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- resources, passing the object as the first parameter, and the string 'resources' as the second parameter

If not, it will return a a Paws::CodeStar::ListResourcesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllTeamMembers(sub { },ProjectId => Str, [MaxResults => Int, NextToken => Str])

ListAllTeamMembers(ProjectId => Str, [MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- teamMembers, passing the object as the first parameter, and the string 'teamMembers' as the second parameter

If not, it will return a a Paws::CodeStar::ListTeamMembersResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllUserProfiles(sub { },[MaxResults => Int, NextToken => Str])

ListAllUserProfiles([MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- userProfiles, passing the object as the first parameter, and the string 'userProfiles' as the second parameter

If not, it will return a a Paws::CodeStar::ListUserProfilesResult instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues