describe_project

describe_project(**kwargs)

Retrieves information about a project.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    projectId='string'
)
Parameters
projectId (string) --

[REQUIRED]

The ID of the project.

Return type
dict
Returns
Response Syntax
{
    'projectId': 'string',
    'projectArn': 'string',
    'projectName': 'string',
    'portalId': 'string',
    'projectDescription': 'string',
    'projectCreationDate': datetime(2015, 1, 1),
    'projectLastUpdateDate': datetime(2015, 1, 1)
}

Response Structure

  • (dict) --
    • projectId (string) --

      The ID of the project.

    • projectArn (string) --

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

      arn:${Partition}:iotsitewise:${Region}:${Account}:project/${ProjectId}
    • projectName (string) --

      The name of the project.

    • portalId (string) --

      The ID of the portal that the project is in.

    • projectDescription (string) --

      The project's description.

    • projectCreationDate (datetime) --

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

    • projectLastUpdateDate (datetime) --

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

Exceptions

  • IoTSiteWise.Client.exceptions.InvalidRequestException
  • IoTSiteWise.Client.exceptions.ResourceNotFoundException
  • IoTSiteWise.Client.exceptions.InternalFailureException
  • IoTSiteWise.Client.exceptions.ThrottlingException