Network.AWS.CodeStar

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.

Service Configuration

codeStar :: Service

API version 2017-04-19 of the Amazon CodeStar SDK configuration.

Errors

Error matchers are designed for use with the functions provided by Control.Exception.Lens. This allows catching (and rethrowing) service specific errors returned by CodeStar.

TeamMemberAlreadyAssociatedException

_TeamMemberAlreadyAssociatedException :: AsError a => Getting (First ServiceError) a ServiceError

The team member is already associated with a role in this project.

ValidationException

_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError

The specified input is either not valid, or it could not be validated.

InvalidServiceRoleException

_InvalidServiceRoleException :: AsError a => Getting (First ServiceError) a ServiceError

The service role is not valid.

ProjectCreationFailedException

_ProjectCreationFailedException :: AsError a => Getting (First ServiceError) a ServiceError

The project creation request was valid, but a nonspecific exception or error occurred during project creation. The project could not be created in AWS CodeStar.

UserProfileAlreadyExistsException

_UserProfileAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError

A user profile with that name already exists in this region for the AWS account. AWS CodeStar user profile names must be unique within a region for the AWS account.

ProjectNotFoundException

_ProjectNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

The specified AWS CodeStar project was not found.

TeamMemberNotFoundException

_TeamMemberNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

The specified team member was not found.

ProjectAlreadyExistsException

_ProjectAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError

An AWS CodeStar project with the same ID already exists in this region for the AWS account. AWS CodeStar project IDs must be unique within a region for the AWS account.

ProjectConfigurationException

_ProjectConfigurationException :: AsError a => Getting (First ServiceError) a ServiceError

Project configuration information is required but not specified.

ConcurrentModificationException

_ConcurrentModificationException :: AsError a => Getting (First ServiceError) a ServiceError

Another modification is being made. That modification must complete before you can make your change.

InvalidNextTokenException

_InvalidNextTokenException :: AsError a => Getting (First ServiceError) a ServiceError

The next token is not valid.

UserProfileNotFoundException

_UserProfileNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError

The user profile was not found.

LimitExceededException

_LimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError

A resource limit has been exceeded.

Waiters

Waiters poll by repeatedly sending a request until some remote success condition configured by the Wait specification is fulfilled. The Wait specification determines how many attempts should be made, in addition to delay and retry strategies.

Operations

Some AWS operations return results that are incomplete and require subsequent requests in order to obtain the entire result set. The process of sending subsequent requests to continue where a previous request left off is called pagination. For example, the ListObjects operation of Amazon S3 returns up to 1000 objects at a time, and you must send subsequent requests with the appropriate Marker in order to retrieve the next page of results.

Operations that have an AWSPager instance can transparently perform subsequent requests, correctly setting Markers and other request facets to iterate through the entire result set of a truncated API operation. Operations which support this have an additional note in the documentation.

Many operations have the ability to filter results on the server side. See the individual operation parameters for details.

ListProjects

module Network.AWS.CodeStar.ListProjects

ListTeamMembers

module Network.AWS.CodeStar.ListTeamMembers

DeleteProject

module Network.AWS.CodeStar.DeleteProject

UpdateProject

module Network.AWS.CodeStar.UpdateProject

DisassociateTeamMember

module Network.AWS.CodeStar.DisassociateTeamMember

TagProject

module Network.AWS.CodeStar.TagProject

DescribeProject

module Network.AWS.CodeStar.DescribeProject

ListUserProfiles

module Network.AWS.CodeStar.ListUserProfiles

ListResources

module Network.AWS.CodeStar.ListResources

AssociateTeamMember

module Network.AWS.CodeStar.AssociateTeamMember

UntagProject

module Network.AWS.CodeStar.UntagProject

UpdateTeamMember

module Network.AWS.CodeStar.UpdateTeamMember

DescribeUserProfile

module Network.AWS.CodeStar.DescribeUserProfile

ListTagsForProject

module Network.AWS.CodeStar.ListTagsForProject

DeleteUserProfile

module Network.AWS.CodeStar.DeleteUserProfile

UpdateUserProfile

module Network.AWS.CodeStar.UpdateUserProfile

CreateUserProfile

module Network.AWS.CodeStar.CreateUserProfile

CreateProject

module Network.AWS.CodeStar.CreateProject

Types

ProjectSummary

data ProjectSummary

Information about the metadata for a project.

See: projectSummary smart constructor.

Instances

Eq ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

(==) :: ProjectSummary -> ProjectSummary -> Bool

(/=) :: ProjectSummary -> ProjectSummary -> Bool

Data ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ProjectSummary -> c ProjectSummary

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ProjectSummary

toConstr :: ProjectSummary -> Constr

dataTypeOf :: ProjectSummary -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ProjectSummary)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ProjectSummary)

gmapT :: (forall b. Data b => b -> b) -> ProjectSummary -> ProjectSummary

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ProjectSummary -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ProjectSummary -> r

gmapQ :: (forall d. Data d => d -> u) -> ProjectSummary -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> ProjectSummary -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> ProjectSummary -> m ProjectSummary

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectSummary -> m ProjectSummary

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ProjectSummary -> m ProjectSummary

Read ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

readsPrec :: Int -> ReadS ProjectSummary

readList :: ReadS [ProjectSummary]

readPrec :: ReadPrec ProjectSummary

readListPrec :: ReadPrec [ProjectSummary]

Show ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

showsPrec :: Int -> ProjectSummary -> ShowS

show :: ProjectSummary -> String

showList :: [ProjectSummary] -> ShowS

Generic ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Associated Types

type Rep ProjectSummary :: Type -> Type

Methods

from :: ProjectSummary -> Rep ProjectSummary x

to :: Rep ProjectSummary x -> ProjectSummary

Hashable ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

hashWithSalt :: Int -> ProjectSummary -> Int

hash :: ProjectSummary -> Int

FromJSON ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

parseJSON :: Value -> Parser ProjectSummary

parseJSONList :: Value -> Parser [ProjectSummary]

NFData ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

rnf :: ProjectSummary -> ()

type Rep ProjectSummary

Defined in Network.AWS.CodeStar.Types.Product

type Rep ProjectSummary = D1 (MetaData "ProjectSummary" "Network.AWS.CodeStar.Types.Product" "amazonka-codestar-1.6.1-CcYQrsIZo67Ij9mcPy3qxj" False) (C1 (MetaCons "ProjectSummary'" PrefixI True) (S1 (MetaSel (Just "_psProjectARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_psProjectId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))

projectSummary :: ProjectSummary

Creates a value of ProjectSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• psProjectARN - The Amazon Resource Name (ARN) of the project.
• psProjectId - The ID of the project.

psProjectARN :: Lens' ProjectSummary (Maybe Text)

The Amazon Resource Name (ARN) of the project.

psProjectId :: Lens' ProjectSummary (Maybe Text)

The ID of the project.

Resource

data Resource

Information about a resource for a project.

See: resource smart constructor.

Instances

Eq Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

(==) :: Resource -> Resource -> Bool

(/=) :: Resource -> Resource -> Bool

Data Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Resource -> c Resource

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Resource

toConstr :: Resource -> Constr

dataTypeOf :: Resource -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Resource)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Resource)

gmapT :: (forall b. Data b => b -> b) -> Resource -> Resource

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Resource -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Resource -> r

gmapQ :: (forall d. Data d => d -> u) -> Resource -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Resource -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Resource -> m Resource

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Resource -> m Resource

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Resource -> m Resource

Read Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

readsPrec :: Int -> ReadS Resource

readList :: ReadS [Resource]

readPrec :: ReadPrec Resource

readListPrec :: ReadPrec [Resource]

Show Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

showsPrec :: Int -> Resource -> ShowS

show :: Resource -> String

showList :: [Resource] -> ShowS

Generic Resource

Defined in Network.AWS.CodeStar.Types.Product

Associated Types

type Rep Resource :: Type -> Type

Methods

from :: Resource -> Rep Resource x

to :: Rep Resource x -> Resource

Hashable Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

hashWithSalt :: Int -> Resource -> Int

hash :: Resource -> Int

FromJSON Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

parseJSON :: Value -> Parser Resource

parseJSONList :: Value -> Parser [Resource]

NFData Resource

Defined in Network.AWS.CodeStar.Types.Product

Methods

rnf :: Resource -> ()

type Rep Resource

Defined in Network.AWS.CodeStar.Types.Product

type Rep Resource = D1 (MetaData "Resource" "Network.AWS.CodeStar.Types.Product" "amazonka-codestar-1.6.1-CcYQrsIZo67Ij9mcPy3qxj" True) (C1 (MetaCons "Resource'" PrefixI True) (S1 (MetaSel (Just "_rId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

resource

Arguments

:: Text

rId

-> Resource

Creates a value of Resource with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rId - The Amazon Resource Name (ARN) of the resource.

rId :: Lens' Resource Text

The Amazon Resource Name (ARN) of the resource.

TeamMember

data TeamMember

Information about a team member in a project.

See: teamMember smart constructor.

Instances

Eq TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

(==) :: TeamMember -> TeamMember -> Bool

(/=) :: TeamMember -> TeamMember -> Bool

Data TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TeamMember -> c TeamMember

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TeamMember

toConstr :: TeamMember -> Constr

dataTypeOf :: TeamMember -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c TeamMember)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TeamMember)

gmapT :: (forall b. Data b => b -> b) -> TeamMember -> TeamMember

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TeamMember -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TeamMember -> r

gmapQ :: (forall d. Data d => d -> u) -> TeamMember -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TeamMember -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TeamMember -> m TeamMember

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TeamMember -> m TeamMember

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TeamMember -> m TeamMember

Read TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

readsPrec :: Int -> ReadS TeamMember

readList :: ReadS [TeamMember]

readPrec :: ReadPrec TeamMember

readListPrec :: ReadPrec [TeamMember]

Show TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

showsPrec :: Int -> TeamMember -> ShowS

show :: TeamMember -> String

showList :: [TeamMember] -> ShowS

Generic TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Associated Types

type Rep TeamMember :: Type -> Type

Methods

from :: TeamMember -> Rep TeamMember x

to :: Rep TeamMember x -> TeamMember

Hashable TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

hashWithSalt :: Int -> TeamMember -> Int

hash :: TeamMember -> Int

FromJSON TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

parseJSON :: Value -> Parser TeamMember

parseJSONList :: Value -> Parser [TeamMember]

NFData TeamMember

Defined in Network.AWS.CodeStar.Types.Product

Methods

rnf :: TeamMember -> ()

type Rep TeamMember

Defined in Network.AWS.CodeStar.Types.Product

type Rep TeamMember = D1 (MetaData "TeamMember" "Network.AWS.CodeStar.Types.Product" "amazonka-codestar-1.6.1-CcYQrsIZo67Ij9mcPy3qxj" False) (C1 (MetaCons "TeamMember'" PrefixI True) (S1 (MetaSel (Just "_tmRemoteAccessAllowed") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)) :*: (S1 (MetaSel (Just "_tmUserARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_tmProjectRole") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))

teamMember

Arguments

:: Text

tmUserARN

-> Text

tmProjectRole

-> TeamMember

Creates a value of TeamMember with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tmRemoteAccessAllowed - Whether the user is allowed to remotely access project resources using an SSH public/private key pair.
• tmUserARN - The Amazon Resource Name (ARN) of the user in IAM.
• tmProjectRole - 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 .

tmRemoteAccessAllowed :: Lens' TeamMember (Maybe Bool)

Whether the user is allowed to remotely access project resources using an SSH public/private key pair.

tmUserARN :: Lens' TeamMember Text

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

tmProjectRole :: Lens' TeamMember Text

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 .

UserProfileSummary

data UserProfileSummary

Information about a user's profile in AWS CodeStar.

See: userProfileSummary smart constructor.

Instances

Eq UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

(==) :: UserProfileSummary -> UserProfileSummary -> Bool

(/=) :: UserProfileSummary -> UserProfileSummary -> Bool

Data UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserProfileSummary -> c UserProfileSummary

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserProfileSummary

toConstr :: UserProfileSummary -> Constr

dataTypeOf :: UserProfileSummary -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserProfileSummary)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserProfileSummary)

gmapT :: (forall b. Data b => b -> b) -> UserProfileSummary -> UserProfileSummary

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserProfileSummary -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserProfileSummary -> r

gmapQ :: (forall d. Data d => d -> u) -> UserProfileSummary -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UserProfileSummary -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserProfileSummary -> m UserProfileSummary

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserProfileSummary -> m UserProfileSummary

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserProfileSummary -> m UserProfileSummary

Show UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

showsPrec :: Int -> UserProfileSummary -> ShowS

show :: UserProfileSummary -> String

showList :: [UserProfileSummary] -> ShowS

Generic UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Associated Types

type Rep UserProfileSummary :: Type -> Type

Methods

from :: UserProfileSummary -> Rep UserProfileSummary x

to :: Rep UserProfileSummary x -> UserProfileSummary

Hashable UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

hashWithSalt :: Int -> UserProfileSummary -> Int

hash :: UserProfileSummary -> Int

FromJSON UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

parseJSON :: Value -> Parser UserProfileSummary

parseJSONList :: Value -> Parser [UserProfileSummary]

NFData UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

Methods

rnf :: UserProfileSummary -> ()

type Rep UserProfileSummary

Defined in Network.AWS.CodeStar.Types.Product

type Rep UserProfileSummary = D1 (MetaData "UserProfileSummary" "Network.AWS.CodeStar.Types.Product" "amazonka-codestar-1.6.1-CcYQrsIZo67Ij9mcPy3qxj" False) (C1 (MetaCons "UserProfileSummary'" PrefixI True) ((S1 (MetaSel (Just "_upsSshPublicKey") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)) :*: S1 (MetaSel (Just "_upsUserARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 (MetaSel (Just "_upsEmailAddress") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 (MetaSel (Just "_upsDisplayName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))))

userProfileSummary :: UserProfileSummary

Creates a value of UserProfileSummary with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• upsSshPublicKey - 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.
• upsUserARN - The Amazon Resource Name (ARN) of the user in IAM.
• upsEmailAddress - The email address associated with the user.
• upsDisplayName - The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name (Mary). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space (MJ, not MM).

upsSshPublicKey :: Lens' UserProfileSummary (Maybe Text)

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.

upsUserARN :: Lens' UserProfileSummary (Maybe Text)

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

upsEmailAddress :: Lens' UserProfileSummary (Maybe Text)

The email address associated with the user.

upsDisplayName :: Lens' UserProfileSummary (Maybe Text)

The display name of a user in AWS CodeStar. For example, this could be set to both first and last name ("Mary Major") or a single name (Mary). The display name is also used to generate the initial icon associated with the user in AWS CodeStar projects. If spaces are included in the display name, the first character that appears after the space will be used as the second character in the user initial icon. The initial icon displays a maximum of two characters, so a display name with more than one space (for example "Mary Jane Major") would generate an initial icon using the first character and the first character after the space (MJ, not MM).