IoTEvents / Client / list_input_routings

list_input_routings#

IoTEvents.Client.list_input_routings(**kwargs)#

Lists one or more input routings.

Request Syntax

response = client.list_input_routings(
    inputIdentifier={
        'iotEventsInputIdentifier': {
            'inputName': 'string'
        },
        'iotSiteWiseInputIdentifier': {
            'iotSiteWiseAssetModelPropertyIdentifier': {
                'assetModelId': 'string',
                'propertyId': 'string'
            }
        }
    },
    maxResults=123,
    nextToken='string'
)

Parameters:

inputIdentifier (dict) –
[REQUIRED]

The identifer of the routed input.
- iotEventsInputIdentifier (dict) –
  
  The identifier of the input routed to AWS IoT Events.
  - inputName (string) – [REQUIRED]
    
    The name of the input routed to AWS IoT Events.
- iotSiteWiseInputIdentifier (dict) –
  
  The identifer of the input routed from AWS IoT SiteWise.
  - iotSiteWiseAssetModelPropertyIdentifier (dict) –
    
    The identifier of the AWS IoT SiteWise asset model property.
    - assetModelId (string) – [REQUIRED]
      
      The ID of the AWS IoT SiteWise asset model.
    - propertyId (string) – [REQUIRED]
      
      The ID of the AWS IoT SiteWise asset property.
maxResults (integer) – The maximum number of results to be returned per request.
nextToken (string) – The token that you can use to return the next set of results.

Return type:

dict

Returns:

Response Syntax

{
    'routedResources': [
        {
            'name': 'string',
            'arn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) –
- routedResources (list) –
  
  Summary information about the routed resources.
  - (dict) –
    
    Contains information about the routed resource.
    - name (string) –
      
      The name of the routed resource.
    - arn (string) –
      
      The ARN of the routed resource. For more information, see Amazon Resource Names (ARNs) in the AWS General Reference.
- nextToken (string) –
  
  The token that you can use to return the next set of results, or null if there are no more results.

Exceptions

IoTEvents.Client.exceptions.InvalidRequestException
IoTEvents.Client.exceptions.ThrottlingException
IoTEvents.Client.exceptions.InternalFailureException
IoTEvents.Client.exceptions.ServiceUnavailableException
IoTEvents.Client.exceptions.ResourceNotFoundException