Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodeStar.DescribeProject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a project and its resources.

Synopsis

data DescribeProject = DescribeProject' {
- id :: Text
}
newDescribeProject :: Text -> DescribeProject
describeProject_id :: Lens' DescribeProject Text
data DescribeProjectResponse = DescribeProjectResponse' {
- arn :: Maybe Text
- clientRequestToken :: Maybe Text
- createdTimeStamp :: Maybe POSIX
- description :: Maybe (Sensitive Text)
- id :: Maybe Text
- name :: Maybe (Sensitive Text)
- projectTemplateId :: Maybe Text
- stackId :: Maybe Text
- status :: Maybe ProjectStatus
- httpStatus :: Int
}
newDescribeProjectResponse :: Int -> DescribeProjectResponse
describeProjectResponse_arn :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_clientRequestToken :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_createdTimeStamp :: Lens' DescribeProjectResponse (Maybe UTCTime)
describeProjectResponse_description :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_id :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_name :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_projectTemplateId :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_stackId :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_status :: Lens' DescribeProjectResponse (Maybe ProjectStatus)
describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int

Creating a Request

data DescribeProject Source #

See: newDescribeProject smart constructor.

Constructors

DescribeProject'
Fields id :: Text The ID of the project.

Instances

Instances details

ToJSON DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods toJSON :: DescribeProject -> Value # toEncoding :: DescribeProject -> Encoding # toJSONList :: [DescribeProject] -> Value # toEncodingList :: [DescribeProject] -> Encoding #
ToHeaders DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods toHeaders :: DescribeProject -> [Header] #
ToPath DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods toPath :: DescribeProject -> ByteString #
ToQuery DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods toQuery :: DescribeProject -> QueryString #
AWSRequest DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Associated Types type AWSResponse DescribeProject # Methods request :: (Service -> Service) -> DescribeProject -> Request DescribeProject # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeProject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeProject))) #
Generic DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Associated Types type Rep DescribeProject :: Type -> Type # Methods from :: DescribeProject -> Rep DescribeProject x # to :: Rep DescribeProject x -> DescribeProject #
Read DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods readsPrec :: Int -> ReadS DescribeProject # readList :: ReadS [DescribeProject] # readPrec :: ReadPrec DescribeProject # readListPrec :: ReadPrec [DescribeProject] #
Show DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods showsPrec :: Int -> DescribeProject -> ShowS # show :: DescribeProject -> String # showList :: [DescribeProject] -> ShowS #
NFData DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods rnf :: DescribeProject -> () #
Eq DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods (==) :: DescribeProject -> DescribeProject -> Bool # (/=) :: DescribeProject -> DescribeProject -> Bool #
Hashable DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods hashWithSalt :: Int -> DescribeProject -> Int # hash :: DescribeProject -> Int #
type AWSResponse DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject type AWSResponse DescribeProject = DescribeProjectResponse
type Rep DescribeProject Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject type Rep DescribeProject = D1 ('MetaData "DescribeProject" "Amazonka.CodeStar.DescribeProject" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "DescribeProject'" 'PrefixI 'True) (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeProject Source #

Arguments

:: Text	`DescribeProject`
-> DescribeProject

Create a value of DescribeProject with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeProject, describeProject_id - The ID of the project.

Request Lenses

describeProject_id :: Lens' DescribeProject Text Source #

The ID of the project.

Destructuring the Response

data DescribeProjectResponse Source #

See: newDescribeProjectResponse smart constructor.

Constructors

DescribeProjectResponse'

Fields

arn :: Maybe Text
The Amazon Resource Name (ARN) for the project.
clientRequestToken :: Maybe Text
A user- or system-generated token that identifies the entity that requested project creation.
createdTimeStamp :: Maybe POSIX
The date and time the project was created, in timestamp format.
description :: Maybe (Sensitive Text)
The description of the project, if any.
id :: Maybe Text
The ID of the project.
name :: Maybe (Sensitive Text)
The display name for the project.
projectTemplateId :: Maybe Text
The ID for the AWS CodeStar project template used to create the project.
stackId :: Maybe Text
The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
status :: Maybe ProjectStatus
The project creation or deletion status.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Associated Types type Rep DescribeProjectResponse :: Type -> Type # Methods from :: DescribeProjectResponse -> Rep DescribeProjectResponse x # to :: Rep DescribeProjectResponse x -> DescribeProjectResponse #
Show DescribeProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods showsPrec :: Int -> DescribeProjectResponse -> ShowS # show :: DescribeProjectResponse -> String # showList :: [DescribeProjectResponse] -> ShowS #
NFData DescribeProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods rnf :: DescribeProjectResponse -> () #
Eq DescribeProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject Methods (==) :: DescribeProjectResponse -> DescribeProjectResponse -> Bool # (/=) :: DescribeProjectResponse -> DescribeProjectResponse -> Bool #
type Rep DescribeProjectResponse Source #
Instance details Defined in Amazonka.CodeStar.DescribeProject type Rep DescribeProjectResponse = D1 ('MetaData "DescribeProjectResponse" "Amazonka.CodeStar.DescribeProject" "amazonka-codestar-2.0-J6u0QgMrENu7wBmwByxQnV" 'False) (C1 ('MetaCons "DescribeProjectResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "clientRequestToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "createdTimeStamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "projectTemplateId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "stackId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectStatus)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))))

newDescribeProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeProjectResponse'`
-> DescribeProjectResponse

Create a value of DescribeProjectResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:arn:DescribeProjectResponse', describeProjectResponse_arn - The Amazon Resource Name (ARN) for the project.

$sel:clientRequestToken:DescribeProjectResponse', describeProjectResponse_clientRequestToken - A user- or system-generated token that identifies the entity that requested project creation.

$sel:createdTimeStamp:DescribeProjectResponse', describeProjectResponse_createdTimeStamp - The date and time the project was created, in timestamp format.

DescribeProjectResponse, describeProjectResponse_description - The description of the project, if any.

DescribeProject, describeProjectResponse_id - The ID of the project.

DescribeProjectResponse, describeProjectResponse_name - The display name for the project.

$sel:projectTemplateId:DescribeProjectResponse', describeProjectResponse_projectTemplateId - The ID for the AWS CodeStar project template used to create the project.

$sel:stackId:DescribeProjectResponse', describeProjectResponse_stackId - The ID of the primary stack in AWS CloudFormation used to generate resources for the project.

$sel:status:DescribeProjectResponse', describeProjectResponse_status - The project creation or deletion status.

$sel:httpStatus:DescribeProjectResponse', describeProjectResponse_httpStatus - The response's http status code.

Response Lenses

describeProjectResponse_arn :: Lens' DescribeProjectResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the project.

describeProjectResponse_clientRequestToken :: Lens' DescribeProjectResponse (Maybe Text) Source #

A user- or system-generated token that identifies the entity that requested project creation.

describeProjectResponse_createdTimeStamp :: Lens' DescribeProjectResponse (Maybe UTCTime) Source #

The date and time the project was created, in timestamp format.

describeProjectResponse_description :: Lens' DescribeProjectResponse (Maybe Text) Source #

The description of the project, if any.

describeProjectResponse_id :: Lens' DescribeProjectResponse (Maybe Text) Source #

The ID of the project.

describeProjectResponse_name :: Lens' DescribeProjectResponse (Maybe Text) Source #

The display name for the project.

describeProjectResponse_projectTemplateId :: Lens' DescribeProjectResponse (Maybe Text) Source #

The ID for the AWS CodeStar project template used to create the project.

describeProjectResponse_stackId :: Lens' DescribeProjectResponse (Maybe Text) Source #

The ID of the primary stack in AWS CloudFormation used to generate resources for the project.

describeProjectResponse_status :: Lens' DescribeProjectResponse (Maybe ProjectStatus) Source #

The project creation or deletion status.

describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int Source #

The response's http status code.