amazonka-codestar-1.5.0: Amazon CodeStar SDK.

Copyright(c) 2013-2017 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.CodeStar.Types

Contents

Description

 

Synopsis

Service Configuration

codeStar :: Service Source #

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

Errors

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

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

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

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

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

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 :: AsError a => Getting (First ServiceError) a ServiceError Source #

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 :: AsError a => Getting (First ServiceError) a ServiceError Source #

The specified AWS CodeStar project was not found.

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

The specified team member was not found.

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

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 :: AsError a => Getting (First ServiceError) a ServiceError Source #

Project configuration information is required but not specified.

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

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

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

A resource limit has been exceeded.

ProjectSummary

data ProjectSummary Source #

Information about the metadata for a project.

See: projectSummary smart constructor.

Instances

Eq ProjectSummary Source # 
Data ProjectSummary Source # 

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 Source # 
Show ProjectSummary Source # 
Generic ProjectSummary Source # 

Associated Types

type Rep ProjectSummary :: * -> * #

Hashable ProjectSummary Source # 
FromJSON ProjectSummary Source # 
NFData ProjectSummary Source # 

Methods

rnf :: ProjectSummary -> () #

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

projectSummary :: ProjectSummary Source #

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 :: Lens' ProjectSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the project.

psProjectId :: Lens' ProjectSummary (Maybe Text) Source #

The ID of the project.

Resource

data Resource Source #

Information about a resource for a project.

See: resource smart constructor.

Instances

Eq Resource Source # 
Data Resource Source # 

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 Source # 
Show Resource Source # 
Generic Resource Source # 

Associated Types

type Rep Resource :: * -> * #

Methods

from :: Resource -> Rep Resource x #

to :: Rep Resource x -> Resource #

Hashable Resource Source # 

Methods

hashWithSalt :: Int -> Resource -> Int #

hash :: Resource -> Int #

FromJSON Resource Source # 
NFData Resource Source # 

Methods

rnf :: Resource -> () #

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

resource Source #

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 Source #

The Amazon Resource Name (ARN) of the resource.

TeamMember

data TeamMember Source #

Information about a team member in a project.

See: teamMember smart constructor.

Instances

Eq TeamMember Source # 
Data TeamMember Source # 

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 Source # 
Show TeamMember Source # 
Generic TeamMember Source # 

Associated Types

type Rep TeamMember :: * -> * #

Hashable TeamMember Source # 
FromJSON TeamMember Source # 
NFData TeamMember Source # 

Methods

rnf :: TeamMember -> () #

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

teamMember Source #

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) Source #

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

tmUserARN :: Lens' TeamMember Text Source #

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

tmProjectRole :: Lens' TeamMember Text Source #

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 Source #

Information about a user's profile in AWS CodeStar.

See: userProfileSummary smart constructor.

Instances

Eq UserProfileSummary Source # 
Data UserProfileSummary Source # 

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 Source # 
Generic UserProfileSummary Source # 
Hashable UserProfileSummary Source # 
FromJSON UserProfileSummary Source # 
NFData UserProfileSummary Source # 

Methods

rnf :: UserProfileSummary -> () #

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

userProfileSummary :: UserProfileSummary Source #

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) Source #

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) Source #

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

upsEmailAddress :: Lens' UserProfileSummary (Maybe Text) Source #

The email address associated with the user.

upsDisplayName :: Lens' UserProfileSummary (Maybe Text) Source #

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).