Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.IoTSiteWise.DescribeProject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about a project.

Synopsis

data DescribeProject = DescribeProject' {
- projectId :: Text
}
newDescribeProject :: Text -> DescribeProject
describeProject_projectId :: Lens' DescribeProject Text
data DescribeProjectResponse = DescribeProjectResponse' {
- projectDescription :: Maybe Text
- httpStatus :: Int
- projectId :: Text
- projectArn :: Text
- projectName :: Text
- portalId :: Text
- projectCreationDate :: POSIX
- projectLastUpdateDate :: POSIX
}
newDescribeProjectResponse :: Int -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> DescribeProjectResponse
describeProjectResponse_projectDescription :: Lens' DescribeProjectResponse (Maybe Text)
describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int
describeProjectResponse_projectId :: Lens' DescribeProjectResponse Text
describeProjectResponse_projectArn :: Lens' DescribeProjectResponse Text
describeProjectResponse_projectName :: Lens' DescribeProjectResponse Text
describeProjectResponse_portalId :: Lens' DescribeProjectResponse Text
describeProjectResponse_projectCreationDate :: Lens' DescribeProjectResponse UTCTime
describeProjectResponse_projectLastUpdateDate :: Lens' DescribeProjectResponse UTCTime

Creating a Request

data DescribeProject Source #

See: newDescribeProject smart constructor.

Constructors

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

Instances

Instances details

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

newDescribeProject Source #

Arguments

:: Text	`$sel:projectId: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:

$sel:projectId:DescribeProject', describeProject_projectId - The ID of the project.

Request Lenses

describeProject_projectId :: Lens' DescribeProject Text Source #

The ID of the project.

Destructuring the Response

data DescribeProjectResponse Source #

See: newDescribeProjectResponse smart constructor.

Constructors

DescribeProjectResponse'

Fields

projectDescription :: Maybe Text
The project's description.
httpStatus :: Int
The response's http status code.
projectId :: Text
The ID of the project.

projectArn :: Text

The ARN of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

projectName :: Text
The name of the project.
portalId :: Text
The ID of the portal that the project is in.
projectCreationDate :: POSIX
The date the project was created, in Unix epoch time.
projectLastUpdateDate :: POSIX
The date the project was last updated, in Unix epoch time.

Instances

Instances details

Eq DescribeProjectResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeProject Methods (==) :: DescribeProjectResponse -> DescribeProjectResponse -> Bool # (/=) :: DescribeProjectResponse -> DescribeProjectResponse -> Bool #
Read DescribeProjectResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeProject Methods readsPrec :: Int -> ReadS DescribeProjectResponse # readList :: ReadS [DescribeProjectResponse] # readPrec :: ReadPrec DescribeProjectResponse # readListPrec :: ReadPrec [DescribeProjectResponse] #
Show DescribeProjectResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeProject Methods showsPrec :: Int -> DescribeProjectResponse -> ShowS # show :: DescribeProjectResponse -> String # showList :: [DescribeProjectResponse] -> ShowS #
Generic DescribeProjectResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeProject Associated Types type Rep DescribeProjectResponse :: Type -> Type # Methods from :: DescribeProjectResponse -> Rep DescribeProjectResponse x # to :: Rep DescribeProjectResponse x -> DescribeProjectResponse #
NFData DescribeProjectResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeProject Methods rnf :: DescribeProjectResponse -> () #
type Rep DescribeProjectResponse Source #
Instance details Defined in Amazonka.IoTSiteWise.DescribeProject type Rep DescribeProjectResponse = D1 ('MetaData "DescribeProjectResponse" "Amazonka.IoTSiteWise.DescribeProject" "libZSservicesZSamazonka-iotsitewiseZSamazonka-iotsitewise" 'False) (C1 ('MetaCons "DescribeProjectResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "projectDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "projectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "portalId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "projectCreationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "projectLastUpdateDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX)))))

newDescribeProjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeProjectResponse'`
-> Text	`$sel:projectId:DescribeProject'`
-> Text	`$sel:projectArn:DescribeProjectResponse'`
-> Text	`$sel:projectName:DescribeProjectResponse'`
-> Text	`$sel:portalId:DescribeProjectResponse'`
-> UTCTime	`$sel:projectCreationDate:DescribeProjectResponse'`
-> UTCTime	`$sel:projectLastUpdateDate: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:projectDescription:DescribeProjectResponse', describeProjectResponse_projectDescription - The project's description.

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

$sel:projectId:DescribeProject', describeProjectResponse_projectId - The ID of the project.

$sel:projectArn:DescribeProjectResponse', describeProjectResponse_projectArn - The ARN of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

$sel:projectName:DescribeProjectResponse', describeProjectResponse_projectName - The name of the project.

$sel:portalId:DescribeProjectResponse', describeProjectResponse_portalId - The ID of the portal that the project is in.

$sel:projectCreationDate:DescribeProjectResponse', describeProjectResponse_projectCreationDate - The date the project was created, in Unix epoch time.

$sel:projectLastUpdateDate:DescribeProjectResponse', describeProjectResponse_projectLastUpdateDate - The date the project was last updated, in Unix epoch time.

Response Lenses

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

The project's description.

describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int Source #

The response's http status code.

describeProjectResponse_projectId :: Lens' DescribeProjectResponse Text Source #

The ID of the project.

describeProjectResponse_projectArn :: Lens' DescribeProjectResponse Text Source #

The ARN of the project, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}

describeProjectResponse_projectName :: Lens' DescribeProjectResponse Text Source #

The name of the project.

describeProjectResponse_portalId :: Lens' DescribeProjectResponse Text Source #

The ID of the portal that the project is in.

describeProjectResponse_projectCreationDate :: Lens' DescribeProjectResponse UTCTime Source #

The date the project was created, in Unix epoch time.

describeProjectResponse_projectLastUpdateDate :: Lens' DescribeProjectResponse UTCTime Source #

The date the project was last updated, in Unix epoch time.