Amazonka.IoTSiteWise.DescribeProject

Retrieves information about a project.

Creating a Request

data DescribeProject

See: newDescribeProject smart constructor.

Constructors

DescribeProject'

Fields

• projectId :: Text

  The ID of the project.

Instances

ToHeaders DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

toHeaders :: DescribeProject -> [Header]

ToPath DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

toPath :: DescribeProject -> ByteString

ToQuery DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

toQuery :: DescribeProject -> QueryString

AWSRequest DescribeProject

Defined in Amazonka.IoTSiteWise.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

Defined in Amazonka.IoTSiteWise.DescribeProject

Associated Types

type Rep DescribeProject :: Type -> Type

Methods

from :: DescribeProject -> Rep DescribeProject x

to :: Rep DescribeProject x -> DescribeProject

Read DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

readsPrec :: Int -> ReadS DescribeProject

readList :: ReadS [DescribeProject]

readPrec :: ReadPrec DescribeProject

readListPrec :: ReadPrec [DescribeProject]

Show DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

showsPrec :: Int -> DescribeProject -> ShowS

show :: DescribeProject -> String

showList :: [DescribeProject] -> ShowS

NFData DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

rnf :: DescribeProject -> ()

Eq DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

(==) :: DescribeProject -> DescribeProject -> Bool

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

Hashable DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

hashWithSalt :: Int -> DescribeProject -> Int

hash :: DescribeProject -> Int

type AWSResponse DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

type AWSResponse DescribeProject = DescribeProjectResponse

type Rep DescribeProject

Defined in Amazonka.IoTSiteWise.DescribeProject

type Rep DescribeProject = D1 ('MetaData "DescribeProject" "Amazonka.IoTSiteWise.DescribeProject" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "DescribeProject'" 'PrefixI 'True) (S1 ('MetaSel ('Just "projectId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeProject

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_projectId - The ID of the project.

Request Lenses

describeProject_projectId :: Lens' DescribeProject Text

The ID of the project.

Destructuring the Response

data DescribeProjectResponse

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

Generic DescribeProjectResponse

Defined in Amazonka.IoTSiteWise.DescribeProject

Associated Types

type Rep DescribeProjectResponse :: Type -> Type

Methods

from :: DescribeProjectResponse -> Rep DescribeProjectResponse x

to :: Rep DescribeProjectResponse x -> DescribeProjectResponse

Read DescribeProjectResponse

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

readsPrec :: Int -> ReadS DescribeProjectResponse

readList :: ReadS [DescribeProjectResponse]

readPrec :: ReadPrec DescribeProjectResponse

readListPrec :: ReadPrec [DescribeProjectResponse]

Show DescribeProjectResponse

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

showsPrec :: Int -> DescribeProjectResponse -> ShowS

show :: DescribeProjectResponse -> String

showList :: [DescribeProjectResponse] -> ShowS

NFData DescribeProjectResponse

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

rnf :: DescribeProjectResponse -> ()

Eq DescribeProjectResponse

Defined in Amazonka.IoTSiteWise.DescribeProject

Methods

(==) :: DescribeProjectResponse -> DescribeProjectResponse -> Bool

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

type Rep DescribeProjectResponse

Defined in Amazonka.IoTSiteWise.DescribeProject

type Rep DescribeProjectResponse = D1 ('MetaData "DescribeProjectResponse" "Amazonka.IoTSiteWise.DescribeProject" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" '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

Arguments

:: Int

$sel:httpStatus:DescribeProjectResponse'

-> Text

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.

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)

The project's description.

describeProjectResponse_httpStatus :: Lens' DescribeProjectResponse Int

The response's http status code.

describeProjectResponse_projectId :: Lens' DescribeProjectResponse Text

The ID of the project.

describeProjectResponse_projectArn :: Lens' DescribeProjectResponse Text

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

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

describeProjectResponse_projectName :: Lens' DescribeProjectResponse Text

The name of the project.

describeProjectResponse_portalId :: Lens' DescribeProjectResponse Text

The ID of the portal that the project is in.

describeProjectResponse_projectCreationDate :: Lens' DescribeProjectResponse UTCTime

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

describeProjectResponse_projectLastUpdateDate :: Lens' DescribeProjectResponse UTCTime

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