IoT1ClickProjects / Client / list_placements
list_placements#
- IoT1ClickProjects.Client.list_placements(**kwargs)#
Lists the placement(s) of a project.
See also: AWS API Documentation
Request Syntax
response = client.list_placements( projectName='string', nextToken='string', maxResults=123 )
- Parameters:
projectName (string) –
[REQUIRED]
The project containing the placements to be listed.
nextToken (string) – The token to retrieve the next set of results.
maxResults (integer) – The maximum number of results to return per request. If not set, a default value of 100 is used.
- Return type:
dict
- Returns:
Response Syntax
{ 'placements': [ { 'projectName': 'string', 'placementName': 'string', 'createdDate': datetime(2015, 1, 1), 'updatedDate': datetime(2015, 1, 1) }, ], 'nextToken': 'string' }
Response Structure
(dict) –
placements (list) –
An object listing the requested placements.
(dict) –
An object providing summary information for a particular placement.
projectName (string) –
The name of the project containing the placement.
placementName (string) –
The name of the placement being summarized.
createdDate (datetime) –
The date when the placement was originally created, in UNIX epoch time format.
updatedDate (datetime) –
The date when the placement was last updated, in UNIX epoch time format. If the placement was not updated, then
createdDate
andupdatedDate
are the same.
nextToken (string) –
The token used to retrieve the next set of results - will be effectively empty if there are no further results.
Exceptions
IoT1ClickProjects.Client.exceptions.InternalFailureException
IoT1ClickProjects.Client.exceptions.InvalidRequestException
IoT1ClickProjects.Client.exceptions.ResourceNotFoundException