IoT1ClickProjects / Client / describe_project

describe_project#

IoT1ClickProjects.Client.describe_project(**kwargs)#

Returns an object describing a project.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    projectName='string'
)
Parameters:

projectName (string) –

[REQUIRED]

The name of the project to be described.

Return type:

dict

Returns:

Response Syntax

{
    'project': {
        'arn': 'string',
        'projectName': 'string',
        'description': 'string',
        'createdDate': datetime(2015, 1, 1),
        'updatedDate': datetime(2015, 1, 1),
        'placementTemplate': {
            'defaultAttributes': {
                'string': 'string'
            },
            'deviceTemplates': {
                'string': {
                    'deviceType': 'string',
                    'callbackOverrides': {
                        'string': 'string'
                    }
                }
            }
        },
        'tags': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) –

    • project (dict) –

      An object describing the project.

      • arn (string) –

        The ARN of the project.

      • projectName (string) –

        The name of the project for which to obtain information from.

      • description (string) –

        The description of the project.

      • createdDate (datetime) –

        The date when the project was originally created, in UNIX epoch time format.

      • updatedDate (datetime) –

        The date when the project was last updated, in UNIX epoch time format. If the project was not updated, then createdDate and updatedDate are the same.

      • placementTemplate (dict) –

        An object describing the project’s placement specifications.

        • defaultAttributes (dict) –

          The default attributes (key/value pairs) to be applied to all placements using this template.

          • (string) –

            • (string) –

        • deviceTemplates (dict) –

          An object specifying the DeviceTemplate for all placements using this ( PlacementTemplate) template.

          • (string) –

            • (dict) –

              An object representing a device for a placement template (see PlacementTemplate).

              • deviceType (string) –

                The device type, which currently must be "button".

              • callbackOverrides (dict) –

                An optional Lambda function to invoke instead of the default Lambda function provided by the placement template.

                • (string) –

                  • (string) –

      • tags (dict) –

        The tags (metadata key/value pairs) associated with the project.

        • (string) –

          • (string) –

Exceptions